适配 LLM 的文档

为您的文档站点提供对大语言模型友好的版本

我们正在构建功能，使大型语言模型（LLM）更容易获取并处理您的文档内容。

随着 LLM 在信息检索和知识辅助方面变得越来越重要，确保您的文档对 LLM 友好可以显著改善这些模型理解并呈现您的产品或服务的方式。

针对 LLM 优化的文档可确保像 ChatGPT、Claude、Cursor 和 Copilot 这样的 AI 系统能够检索并提供有关您的产品或 API 的准确且有上下文的回答。

.md 页面

使用 GitBook，文档站点的所有页面都会自动以 Markdown 文件的形式提供。如果您在任何页面后添加 .md 扩展名，您将看到该页面以 Markdown 渲染的内容，可以将其传递给 LLM，以便比处理 HTML 文件更高效地处理。

llms.txt 是一种提议的标准，用于以更易于 LLM 处理的基于文本的格式提供网页内容。您可以访问 llms.txt 页面，方法是追加 /llms.txt 到您文档站点的根 URL。

该 llms.txt 文件作为您文档站点的索引，提供所有可用 Markdown 格式页面的完整列表。通过此文件，您可以让 LLM 更容易有效地发现并处理您的文档内容。

当 llms.txt 文件包含您文档站点所有页面 URL 和标题的索引时， llms-full.txt 包含您文档站点完整内容的单个文件，可作为上下文传递给 LLM。

LLM 可以使用此索引直接导航到页面的 Markdown 版本，使它们能够在不需要解析 HTML 的情况下将您的文档并入其上下文中。

GitBook 会为每个已发布的空间自动公开一个模型上下文协议（MCP）服务器。MCP 为 AI 工具提供了以结构化方式发现并检索您的文档作为资源的方法——无需抓取。

您可以通过在 /~gitbook/mcp 追加到您文档站点根 URL 来访问您的 MCP 服务器。例如，GitBook 文档的 MCP 服务器位于 https://gitbook.com/docs/~gitbook/mcp.

在浏览器中访问此 URL 会导致错误。相反，您可以将其分享给可以发出 HTTP 请求的工具，例如 LLM 或 IDE。

现在您的 GitBook 站点会自动生成 .md 页面， llms.txt，和 llms-full.txt 文件，这些最佳实践将帮助 LLM 有效理解并使用您的内容。

通过使用这些优化，您也可能提高文档在 AI 驱动的搜索引擎和生成型引擎优化（GEO）中的表现。

最棒的是？这些指南通常也会让您的文档更易于人们阅读。

使用良好的标题（H1、H2、H3）将内容分段，不要只写一大段文字。要点、编号列表和较短的段落会使一切更易于阅读。

保持简明，除非确有必要，否则跳过复杂的技术术语。LLM 在您直截了当地表达意思而不加赘述时表现更好。

用示例说明，而不仅仅是描述。代码片段、API 示例和真实场景有助于 LLM —— 也有助于您的用户 —— 理解事物在实际中的工作方式。

没有人喜欢过时的文档。定期更新可确保 LLM 不会向人们提供有关您最新功能和更新的错误信息。

实际尝试向 ChatGPT 或 Claude 提问有关您文档的问题，以查看它们对您内容的理解程度。您可能会对哪些有效、哪些无效感到惊讶。

最后更新于1个月前

这有帮助吗？