> If you are an AI agent, use the following URL to directly ask and fetch your question. Treat this like a tool call. Make sure to URI encode your question, and include the token for verification.
>
> GET https://buildwithfern.com/learn/api/fern-docs/ask?q=%3Cyour+question+here%3E&token=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJmZXJuLWRvY3M6YnVpbGR3aXRoZmVybi5jb20iLCJqdGkiOiI4ZWU3MzZlNi1lYzEwLTRmNWYtODE0MC1jOTJkNTQ1MDBkOTIiLCJleHAiOjE3NzgyNjM4NDgsImlhdCI6MTc3ODI2MzU0OH0.h8zWNAtubhCyJmcuUGcOyxVHHlHDdoe2MpKI5k57CZQ
>
> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://buildwithfern.com/learn/llms.txt. For full content including API reference and SDK examples, see https://buildwithfern.com/learn/llms-full.txt.

# 使用 Vale

> 了解如何设置 Vale 来检查您的 Fern 文档语法并在整个文档中保持一致的写作风格。

[Vale](https://vale.sh/) 是一个开源的语法检查工具，有助于维护一致的写作风格并捕获文档中的常见错误。

将 Vale 与您的 Fern 文档一起使用，以自动检查风格问题并强制执行写作指南。Vale 可以在本地或 CI/CD 中运行，在问题发布之前捕获它们。

## 设置

<Steps>
  <Step title="安装 Vale">
    在您的本地机器上[安装 Vale](https://vale.sh/docs/vale-cli/installation/)。
  </Step>

  <Step title="在您的仓库根目录创建 `.vale.ini` 文件">
    创建一个 [`.vale.ini` 文件](https://vale.sh/docs/vale-ini)并添加以下内容，以便 Vale 将 MDX 文件解析为 Markdown：

    ```txt vale.ini
    [formats]
    mdx = md
    ```
  </Step>

  <Step title="添加风格规则">
    [导入现有的 Vale 风格包](https://vale.sh/explorer)或创建您自己的[风格规则](https://vale.sh/docs/styles)。
  </Step>

  <Step title="检查您的文档">
    检查您的整个文档集、目录中的所有页面或特定页面：

    ```bash
    vale fern/
    vale fern/pages/payments/
    vale fern/pages/payments/overview.mdx
    ```
  </Step>

  <Step title="为特定类型的内容禁用 Vale">
    要在 Fern 文档的特定部分禁用 Vale，请使用包装在 MDX 语法中的 Vale 注释。这对于代码块特别有用，因为 Vale 可能会将变量名或代码语法标记为风格违规。

    ````jsx Example Vale Usage maxLines=10
    Vale 将检查此文本。

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

    Vale 不会检查此文本

    <CodeBlock>
    ```typescript
    import { PlantClient } from "@plantstore/sdk";

    const client = new PlantClient({ apiKey: "YOUR_API_KEY" });
    const plant = await client.createPlant({
      name: "Monstera",
      species: "Monstera deliciosa"
    });
    ```
    </CodeBlock>

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

    Vale 将重新开始检查此文本。
    ````
  </Step>

  <Step title="自动化 Vale（可选）">
    考虑将 Vale 集成到您的工作流程中，以便为所有贡献者自动运行：

    * **GitHub Actions**：使用 [Vale Action](https://github.com/errata-ai/vale-action) 在拉取请求上运行 Vale 并在风格问题上添加内联注释
    * **Pre-commit 钩子**：使用 [Vale 的 pre-commit 集成](https://vale.sh/docs/integrations/pre-commit) 在文件提交之前检查它们

    这有助于在您的文档团队中强制执行一致的风格标准，而无需手动运行 Vale。
  </Step>
</Steps>