跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://mintlify-mintlify-llmstxt-truncation-docs-1773252755.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

llms.txt 文件 是一种行业标准，可帮助大语言模型 (LLM) 更高效地索引内容，类似于站点地图对搜索引擎的作用。AI 工具可以使用此文件理解你的文档结构，并定位与用户查询相关的内容。 Mintlify 会在项目根目录自动托管一个 llms.txt 文件，列出文档中的所有可用页面。该文件始终保持最新且无需维护。你也可以在项目根目录添加自定义的 llms.txt 文件。
如果你的站点需要认证，查看 llms.txt 和 llms-full.txt 也同样需要认证。无法通过你站点认证的 LLM 和 AI 工具将无法访问这些文件。这些文件会排除属于用户分组的页面。
将 /llms.txt 追加到你的文档站点 URL 后查看 llms.txt。

​
llms.txt 结构

llms.txt 文件是一个纯 Markdown 文件，包含：
  • 以 H1 标题形式呈现的站点标题。
  • 结构化内容部分，包含链接以及文档中每个页面的说明。
  • 指向 OpenAPI 和 AsyncAPI 规范的 API 规范链接 (如果文档中包含这些规范) 。
llms.txt 文件会按照页面在存储库中的位置，以字母顺序列出，从根目录开始。 每个页面的说明来自其 frontmatter 中的 description 字段。对于 API 参考页面，说明中还会包含来自 openapi 或 api frontmatter 字段的规范信息。没有 description 字段的页面将在 llms.txt 中显示，但不含说明。 说明内容将被截断至 300 个字符。如果说明包含多个段落，则仅保留第一段。超出长度的说明将以省略号 (…) 结尾。
Example llms.txt
# 站点标题

## 文档

- [API](https://example.com/docs/api): 端点列表和使用方法
- [安装](https://example.com/docs/install): 设置步骤
- [快速开始](https://example.com/docs/start): 入门指南

## API 规范

- [openapi](https://example.com/docs/openapi.json)
- [asyncapi](https://example.com/docs/asyncapi.yaml)
这种结构化方法使 LLM 能够高效地从宏观层面处理你的文档，并为用户查询定位相关内容，从而提升 AI 辅助文档搜索的准确性和速度。

​
llms-full.txt

llms-full.txt 文件会将你的整个文档站点整合为一个文件，供 AI 工具作为 context 使用，并用于 LLM 索引。 Mintlify 会在你的项目根目录自动托管一个 llms-full.txt 文件。你可以在文档站点的 URL 末尾追加 /llms-full.txt 来查看该文件。Mintlify 还会在 /.well-known/llms-full.txt 托管该文件，以兼容采用 .well-known 约定的工具。

​
自定义文件

要添加自定义的 llms.txt 或 llms-full.txt 文件，请在项目根目录创建同名文件。添加自定义文件会覆盖同名的自动生成文件。如果你删除自定义文件，Mintlify 会恢复使用同名的自动生成文件。 自定义的 llms.txt 或 llms-full.txt 文件必须包含一个以 H1 标题呈现的站点标题。其他内容为可选。有关可选部分和最佳实践的更多信息，请参阅 llms.txt 规范中的Format。