Pro 和 Enterprise 方案 包含针对 GitHub 仓库的 CI 检查。
使用 CI 检查为文档执行规范校验、捕捉错误，并在部署前给出警告。CI 检查会在你配置的部署分支上有提交时运行，或在针对该分支的拉取请求上运行。

​
安装

首先，请按照 GitHub 页面上的步骤操作。 对于 GitHub 应用，您可以选择只为单个仓库授予权限。我们强烈建议这样做，因为我们只需要访问托管您文档的那个仓库。

​
配置

前往仪表盘的 Add-ons 页面，配置要为某次部署启用的 CI 检查。打开你希望运行的检查项。 启用检查时，你可以选择将其设为 Warning 或 Blocking 级别。
  • 设为 Warning 级别的检查即使存在错误或建议，也不会标记为失败。
  • 设为 Blocking 级别的检查如果未通过，或提出了需要更改的建议，则会标记为失败。

​
可用的 CI 校验

类似于你在本地使用 CLI link checker 的方式，我们会自动检查文档中的失效链接。 要查看检查结果，请前往 GitHub 上对应提交的检查结果页面。

​
Vale

Vale 是一款开源的基于规则的文本写作校验工具，支持多种文档类型，包括 Markdown 和 MDX。 Mintlify 支持在 CI 流程中自动运行 Vale，并将结果显示为检查状态。

​
配置

如果在部署的根内容目录下有 .vale.ini 文件，我们会自动使用该配置文件。我们也会自动使用你在 stylesPath 中指定的任何配置文件。 如果你没有 Vale 配置文件，将自动加载默认配置。
默认 vale.ini 配置（可展开）
# Top level styles
StylesPath = /app/styles
MinAlertLevel = suggestion
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code

# Vocabularies
Vocab = Mintlify

# This is required since Vale doesn't officially support MDX
[formats]
mdx = md

# MDX support
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Enforces really harsh capitalization rules, keep off

# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
# `{ ... }`
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

# Exclude:
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})

CommentDelimiters = {/*, */}
默认 Vale 词汇表（可展开）
Mintlify
mintlify
VSCode
openapi
OpenAPI
Github
APIs

repo
npm
dev

Lorem
ipsum
impsum
amet

const
myName
myObject
bearerAuth
favicon
topbar
url
borderRadius
args
modeToggle
ModeToggle
isHidden
autoplay

_italic_
Strikethrough
Blockquotes
Blockquote
Singleline
Multiline

onboarding

async
await
boolean
enum
func
impl
init
instanceof
typeof
params
stdin
stdout
stderr
stdout
stdin
var
const
let
null
undefined
struct
bool

cors
csrf
env
xhr
xhr2
jwt
oauth
websocket
localhost
middleware
runtime
webhook
stdin
stdout

json
yaml
yml
md
txt
tsx
jsx
css
scss
html
png
jpg
svg

cdn
cli
css
dom
dto
env
git
gui
http
https
ide
jvm
mvc
orm
rpc
sdk
sql
ssh
ssl
tcp
tls
uri
url
ux
ui

nodejs
npm
yarn
pnpm
eslint
pytest
golang
rustc
kubectl
mongo
postgres
redis

JavaScript
TypeScript
Python
Ruby
Rust
Go
Golang
Java
Kotlin
Swift
Node.js
NodeJS
Deno

React
Vue
Angular
Next.js
Nuxt
Express
Django
Flask
Spring
Laravel
Redux
Vuex
TensorFlow
PostgreSQL
MongoDB
Redis
PNPM

Docker
Kubernetes
AWS
Azure
GCP
Terraform
Jenkins
CircleCI
GitLab
Heroku

Git
git
GitHub
GitLab
Bitbucket
VSCode
Visual Studio Code
IntelliJ
WebStorm
ESLint
eslint
Prettier
prettier
Webpack
webpack
Vite
vite
Babel
babel
Jest
jest
Mocha
Cypress
Postman

HTTP
HTTPS
OAuth
JWT
GraphQL
REST
WebSocket
TCP/IP

NPM
Yarn
PNPM
Pip
PIP
Cargo
RubyGems

Swagger
OpenAPI
Markdown
MDX
Storybook
TypeDoc
JSDoc

MySQL
PostgreSQL
MongoDB
Redis
Elasticsearch
DynamoDB

Linux
Unix
macOS
iOS

Firefox
Chromium
WebKit

config
ctx
desc
dir
elem
err
len
msg
num
obj
prev
proc
ptr
req
res
str
tmp
val
vars

todo
href
lang
nav
prev
next
toc
请注意，出于安全原因，我们无法支持任何绝对路径的 stylesPath，或包含 .. 的 stylesPath。请使用相对路径，并在你的代码仓库中包含该 stylesPath。

​
软件包

Vale 支持多种软件包，可用于检查拼写和样式错误。 任何你在代码库中按正确的 stylesPath 放置的包都会被自动安装，并用于你的 Vale 配置。 对于未包含在代码库中的包，你可以从 Vale 包注册表 指定任意软件包，系统会自动下载并用于你的 Vale 配置。
请注意，出于安全考虑，我们无法支持自动下载不来自 Vale 包注册表 的软件包。

​
搭配 MDX 使用 Vale

Vale 并不原生支持 MDX，但其作者提供了一个自定义扩展来实现支持。 如果你不想使用该扩展，建议在 .vale.ini 文件中添加以下配置： 
[formats]
mdx = md

[*.mdx]
CommentDelimiters = {/*, */}

TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
要在文档中使用 Vale 的行内注释，请使用 MDX 风格注释 {/* ... */}。如果在配置中启用了 CommentDelimiters = {/*, */} 设置，Vale 会在代码检查时自动识别这些注释。这样你就可以轻松使用 Vale 的内置功能，例如跳过某些行或段落。 
{/* vale off */}

This text will be ignored by Vale

{/* vale on */}
如果你不使用 CommentDelimiters，但仍要使用 Vale 的注释，则必须将所有 Vale 注释包裹在 MDX 注释 {/* ... */} 中。例如： 
{/* <!-- vale off --> */}

This text will be ignored by Vale

{/* <!-- vale on --> */}
这些注释标签不支持在 Mintlify 组件内部使用，但可以在文档的顶层任意位置使用。