CI 检查

在更新流程中添加死链检测、lint 与语法检查

Pro 和 Enterprise 套餐包含针对 GitHub 仓库的 CI 检查。

使用 CI 检查对文档进行 lint、发现错误，并在部署前提供 Warning。CI 检查会在对已配置的部署用分支的提交上，或针对该分支的拉取请求（PR）上运行。

​

安装

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

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

​

配置

前往控制台的 附加组件 页面，配置在部署中启用的 CI 检查。启用你希望运行的检查项。

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

• Warning 级别的检查即使存在错误或建议，也不会标记为失败。
• Blocking 级别的检查若未通过或提出了更改建议，将标记为失败。

​

可用的 CI 检查

​

断链

与本地的 CLI 链接检查器 类似，我们会自动扫描文档中的断链。

要查看检查结果，请前往 GitHub 上该特定提交的检查结果页面。

​

Vale

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

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

​

配置

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

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

Default vale.ini configuration

# 顶级样式
StylesPath = /app/styles
MinAlertLevel = suggestion
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 = {/*, */}

Default Vale vocabulary

Mintlify
mintlify
VSCode
openapi
OpenAPI
GitHub
API

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（JSON Web Token）
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 的包。

​

在 MDX 中使用 Vale

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 会在 lint 过程中自动识别这些注释。这样你就可以轻松使用 Vale 的内置功能，比如跳过某些行或部分。

{/* vale off */}

此文本将被 Vale 忽略

{/* vale on */}

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

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

此文本将被 Vale 忽略

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

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