Skip to main content
Pro 和 Enterprise 方案包含针对 GitHub 存储库的 CI 检查。
使用 CI 检查对文档进行 lint，捕捉错误并在部署前给出 Warning。Mintlify 的 CI 检查会在指向已配置部署用分支的拉取请求（PR）上运行。

​
安装

首先，请按照 GitHub 页面上的步骤进行操作。
Mintlify GitHub 应用只需要访问存放文档内容的存储库。我们建议仅授予该存储库的访问权限。

​
配置

前往控制台的 附加组件 页面，配置在部署中启用的 CI 检查。开启你希望运行的检查。 启用检查时，你可以选择以 Warning 或 Blocking 级别运行。
  • Warning 级别的检查即使出现错误或提出建议，也不会标记为失败。
  • Blocking 级别的检查如果出现错误或提出建议，则会标记为失败。

​
可用的 CI 检测

与CLI 链接检查器在本地环境中的工作方式类似，失效链接 CI 检查会自动扫描你的文档内容，查找站点内页面之间的失效内部链接。它不会检查指向其他网站的外部链接。 要查看拉取请求中失效链接的详细结果，请点击 Checks 选项卡并选择 Mintlify 失效链接检查。结果会列出拉取请求中发现的包含失效链接的文件。

​
Vale

Vale 是一款开源的、基于规则的文本风格检查工具（prose linter），支持多种文档类型，包括 Markdown 和 MDX。使用 Vale 可以检查文档中的写作风格和语气是否一致。 Mintlify 支持在 CI 检查中自动运行 Vale，并将结果显示为检查状态。

​
配置

如果在你的部署的内容根目录中有一个 .vale.ini 文件，那么 Vale CI 检查会使用该配置文件以及你在 stylesPath 中指定的任何配置文件。 如果你没有 Vale 配置文件，则会自动加载默认配置。
Default vale.ini configuration
默认的 Vale 词汇列表包含以下词汇。
Default Vale vocabulary
要在默认配置中添加你自己的词表，请创建一个 styles/config/vocabularies/Mintlify 目录，并在其中添加 accept.txt 和 reject.txt 文件。
  • accept.txt: Vale linter 应忽略的词语，例如产品名称或不常见的术语。
  • reject.txt: Vale linter 应标记为错误的词语，例如与你文档语气不相符的行话或用词。
Example Vale file structure
Example monorepo Vale file structure
出于安全原因，不支持使用绝对路径形式的 stylesPath，也不支持包含 .. 的 stylesPath。请使用相对路径，并在你的存储库中包含该 stylesPath。

​
软件包

Vale 支持一系列检查拼写和写作风格错误的软件包。任何你在存储库中放在正确 stylesPath 下的软件包，都会自动安装并随你的 Vale 配置运行。 对于未包含在存储库中的软件包，你可以指定来自 Vale package registry 的任意软件包，它们会被自动下载并在你的 Vale 配置中使用。
出于安全原因，不支持自动下载不来自 Vale package registry 的软件包。

​
将 Vale 与 MDX 搭配使用

对 MDX 的原生支持需要 Vale 3.10.0 或更高版本。使用 vale --version 来检查你的 Vale 版本。
要在 MDX 文件中使用 Vale 的文内注释，请使用 MDX 风格的注释 {/* ... */}：
Vale 会在 MDX 文件中自动识别并遵守这些注释，无需额外配置。使用注释来跳过你希望 linter 忽略的行或片段。
不要将 {/* vale off */} 或类似的 MDX 表达式注释放在 JSX 组件内，作为位于同级元素之间的直接子元素。例如，在 <Steps> 组件内部的两个 <Step> 元素之间。请将注释放在某个特定元素的内容内部，或通过重构内容结构来避免需要使用这些注释。