CI 检查

在更新流程中添加断链、规范与语法检查

Pro 和 Enterprise 方案包含针对 GitHub 仓库的 CI 检查。

使用 CI 检查对你的文档进行问题扫描，并在部署前给出警告。CI 检查被配置为在提交到你设置的部署分支时运行，或在针对该分支的拉取请求中运行。

​

安装

首先，按照 GitHub 页面上的步骤进行操作。

对于 GitHub 应用，您可以选择只为单个仓库授予权限。我们强烈建议这样做，因为我们只需要访问托管您文档的那个仓库。

​

配置

在控制台的 Add-ons 页面为部署配置要启用的 CI 检查。打开你希望运行的检查。

启用检查时，你可以选择以 Warning 或 Blocking 级别运行。

• Warning 级别的检查即使存在错误或建议，也不会返回失败状态。
• Blocking 级别的检查如果未通过或存在建议的更改，则会返回失败状态。

​

可用的 CI 检查

​

失效链接

与本地的CLI 链接检查器工作方式类似，我们会自动检查文档中的失效链接。

要查看检查结果，请访问对应提交的 GitHub 检查结果页面。

​

Vale

Vale 是一个开源的、基于规则的文本风格校验工具，支持包括 Markdown 和 MDX 在内的多种文档类型。

Mintlify 支持在 CI 检查中自动运行 Vale，并将结果显示为检查状态。

​

配置

如果你的部署在内容根目录下有 .vale.ini 文件，我们会自动使用该配置文件。同时，我们也会自动使用你在 stylesPath 中指定的任何配置文件。

如果你没有 Vale 配置文件，将使用默认配置。

默认 vale.ini 配置（可展开）

# 顶级样式
StylesPath = /app/styles
最低告警级别 = 建议
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code

# 词汇
Vocab = Mintlify

# 必需项，因为 Vale 尚未正式支持 MDX
[formats]
mdx = md

# MDX 支持
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # 会强制执行非常严格的大小写规则，请保持关闭

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

# 排除：
# `<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_
删除线
块引用
引用
单行
多行

新手引导

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 package registry 指定任意软件包，它们会被自动下载并在你的 Vale 配置中使用。

出于安全原因，请注意我们无法支持自动下载不来自 Vale package registry 的软件包。

​

Vale 与 MDX

Vale 并不原生支持 MDX，但 Vale 作者提供了一个自定义扩展来支持它。

如果你不想使用该扩展，我们建议在你的 .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 */}

Vale 将忽略此文本

{/* vale on */}

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

{/* <!-- vale off --> */}

这段文本将被 Vale 忽略

{/* <!-- vale on --> */}

这些注释标签在 Mintlify 组件内不受支持，但可以在文档的顶层任意位置使用。