Skip to main content

​
CI checks

Add checks for broken links, linting, and grammar to the updating process
Plans: Pro and Enterprise plans include CI checks for GitHub repositories. See pricing.
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.

​
Installation

To begin, follow the steps on the GitHub setup guide. For GitHub Apps, you can choose to give permissions to only a single repository. We recommend doing so, as access is only needed for the repository where your docs are hosted.

​
Configuration

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.
  • Warning: Will never provide a failure status, even if there are errors or suggestions.
  • Blocking: Will provide a failure status if not passed, or when changes are suggested.

​
Available CI checks

Similar to how the CLI link checker works on your local machine, CI automatically checks your docs for broken links. To see the results, visit GitHub’s check results page for the specific commit.

​
Vale

Vale is an open-source rule-based prose linter that 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.

​
Configuration

If you have a .vale.ini file in the root content directory for your deployment, Mintlify will automatically use that configuration file. It also uses any configuration files in your specified stylesPath. If you do not have a Vale config file, the default configuration automatically loads.
Warning: For security reasons, Mintlify does not support absolute stylesPath values or any stylesPath that includes ... Use a relative stylesPath within your repository.

​
Packages

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.
Warning: For security reasons, CI cannot automatically download packages that are not from the Vale package registry.

​
Vale with MDX

Vale does not natively support MDX, but Vale’s author provides a custom extension to support it. If you prefer not to use this extension, add the following lines to 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.
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:
These comment tags are not supported within Mintlify components but can be used anywhere at the base level of a document.