Use CI checks to lint your docs for errors and provide warnings before you deploy. CI checks are configured to run on commits to your configured deployment branch, or on pull requests against that branch.
To begin, follow the steps on the GitHub page.For GitHub Apps, you can choose to give permissions to only a single repository. We highly recommend you do so as we only need access to the repository where your docs are hosted.
Configure the CI checks enabled for a deployment by navigating to the Add-ons page of your dashboard. Enable the checks that you want to run.When enabling checks, you can choose to run them at a Warning or Blocking level.
A Warning level check will never provide a failure status, even if there is an error or suggestions.
A Blocking level check will provide a failure status if not passed, or changes are suggested.
Similar to how the CLI link checker works on your local machine, we automatically check your docs for broken links.To see the results of this check, visit GitHub’s check results page for a specific commit.
Vale is an open-source rule-based prose linter which supports a range of document types, including Markdown and MDX.Mintlify supports automatically running Vale in a CI check and displaying the results as a check status.
If you have a .vale.ini file in the root content directory for your deployment, we automatically use that configuration file. We also automatically use any configuration files in your specified stylesPath.If you do not have a Vale config file, the default configuration automatically loads.
MintlifymintlifyVSCodeopenapiOpenAPIGithubAPIsreponpmdevLoremipsumimpsumametconstmyNamemyObjectbearerAuthfavicontopbarurlborderRadiusargsmodeToggleModeToggleisHiddenautoplay_italic_StrikethroughBlockquotesBlockquoteSinglelineMultilineonboardingasyncawaitbooleanenumfuncimplinitinstanceoftypeofparamsstdinstdoutstderrstdoutstdinvarconstletnullundefinedstructboolcorscsrfenvxhrxhr2jwtoauthwebsocketlocalhostmiddlewareruntimewebhookstdinstdoutjsonyamlymlmdtxttsxjsxcssscsshtmlpngjpgsvgcdnclicssdomdtoenvgitguihttphttpsidejvmmvcormrpcsdksqlsshssltcptlsuriurluxuinodejsnpmyarnpnpmeslintpytestgolangrustckubectlmongopostgresredisJavaScriptTypeScriptPythonRubyRustGoGolangJavaKotlinSwiftNode.jsNodeJSDenoReactVueAngularNext.jsNuxtExpressDjangoFlaskSpringLaravelReduxVuexTensorFlowPostgreSQLMongoDBRedisPNPMDockerKubernetesAWSAzureGCPTerraformJenkinsCircleCIGitLabHerokuGitgitGitHubGitLabBitbucketVSCodeVisual Studio CodeIntelliJWebStormESLinteslintPrettierprettierWebpackwebpackViteviteBabelbabelJestjestMochaCypressPostmanHTTPHTTPSOAuthJWTGraphQLRESTWebSocketTCP/IPNPMYarnPNPMPipPIPCargoRubyGemsSwaggerOpenAPIMarkdownMDXStorybookTypeDocJSDocMySQLPostgreSQLMongoDBRedisElasticsearchDynamoDBLinuxUnixmacOSiOSFirefoxChromiumWebKitconfigctxdescdirelemerrlenmsgnumobjprevprocptrreqresstrtmpvalvarstodohreflangnavprevnexttoc
Please note that for security reasons, we are unable to support any absolute stylesPath, or stylesPath which include .. values. Please use relative paths and include the stylesPath in your repository.
Vale supports a range of packages, which can be used to check for spelling and style errors.
Any packages you include in your repository under the correct stylesPath are automatically installed and used in your Vale configuration.For packages not included in your repository, you may specify any packages from the Vale package registry, and they are automatically downloaded and used in your Vale configuration.
Please note that for security reasons, we are unable to support automatically downloading packages that are not from the Vale package registry.
Vale does not natively support MDX, but Vale’s author has provided a custom extension to support it.If you prefer not to use this extension, we recommend the following lines in your .vale.ini file:
To use Vale’s in-document comments, use MDX-style comments {/* ... */}. If you use the CommentDelimiters = {/*, */}setting in your configuration, Vale automatically interprets these comments while linting. This means you can easily use Vale’s built-in features, like skipping lines or sections.
Copy
{/* vale off */}This text will be ignored by Vale{/* vale on */}
If you choose not to use CommentDelimiters but still choose to use Vale’s comments, you must wrap any Vale comments in MDX comments {/* ... */}. For example:
Copy
{/* <!-- vale off --> */}This text will be ignored by Vale{/* <!-- vale on --> */}
These comment tags are not supported within Mintlify components but can be used anywhere at the base level of a document.
