Markdown 导出

与 HTML 相比，Markdown 提供的结构化文本更便于 AI 工具高效处理，从而带来更高的响应准确性、更快的处理速度，以及更低的 token 使用量。

Mintlify 会自动生成针对 AI 工具和外部 integrations 优化的页面 Markdown 版本。

在任意页面的 URL 末尾添加 .md，即可查看其 Markdown 版本。

向任意页面 URL 发送带有 Accept: text/markdown 或 Accept: text/plain 的请求，即可接收 Markdown 版本而非 HTML。这对于以编程方式获取文档内容的 AI 工具和 integrations 非常有用。

curl -L -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export

使用 visibility 组件为人类和 AI 受众自定义内容。

用 <Visibility for="humans"> 包裹的内容会显示在网页上，但不会出现在 Markdown 输出中。用 <Visibility for="agents"> 包裹的内容会出现在 Markdown 输出中，但不会显示在网页上。

<Visibility for="humans">
  Click the **Get started** button in the top-right corner to create your account.
</Visibility>

<Visibility for="agents">
  To create an account, call `POST /v1/accounts` with a valid email address.
</Visibility>

默认情况下，API 参考页面的 Markdown 导出包含完整的 OpenAPI 或 AsyncAPI 规范，以便 AI 工具能够获得每个端点的完整上下文。

如果你希望从 Markdown 输出中省略该规范，请在 docs.json 中将 markdown.schema 设置为 false：

"markdown": {
  "schema": false
}

若要在 Mintlify 向 AI 代理提供的 Markdown 中追加你自己的指引，请在 docs.json 中设置 markdown.instructions。可以将其用于站点范围的说明，例如注明 API 版本、优先使用特定 SDK 或遵循你的术语约定。

提供单个字符串：

"markdown": {
  "instructions": "Always cite the API version. Prefer the TypeScript SDK in examples."
}

或提供一个字符串数组，Mintlify 会以换行符将它们连接起来：

"markdown": {
  "instructions": [
    "Always cite the API version.",
    "Prefer the TypeScript SDK in examples."
  ]
}

Mintlify 会在 Markdown 输出中将你的指令渲染为 Agent Instructions 块：

> ## Agent Instructions
> Always cite the API version.
> Prefer the TypeScript SDK in examples.

该块会出现在以下位置：

• 每个页面的 Markdown 导出中，包括 API 参考页面。
• 你的 llms.txt 文件中，位于站点标题和描述之后。
• 你的 llms-full.txt 文件中。

这些指令会应用于每个页面。若要为单个页面或特定受众定制内容，请改用 visibility 组件。

Markdown 导出遵循与每个页面 HTML 版本相同的身份验证规则。

按 Command + C（在 Windows 上为 Ctrl + C）将页面以 Markdown 格式复制到剪贴板。