跳转到主要内容
llms.txt 文件 是一项行业标准,可帮助 LLM 更高效地索引内容,类似于站点地图之于搜索引擎。AI 工具可以使用该文件了解你的文档结构,并定位与用户查询相关的内容。 Mintlify 会在你的项目根目录自动托管一个 llms.txt 文件,列出文档中的所有可用页面。该文件始终保持最新且无需维护。你也可以选择在项目根目录添加自定义的 llms.txt 文件。 在文档站点的 URL 末尾追加 /llms.txt 即可查看 llms.txt 打开此站点的 llms.txt。

llms.txt 结构

llms.txt 文件是一个纯文本的 Markdown 文件,包含:
  • 作为 H1 标题的站点标题
  • 结构化内容部分,其中包含链接以及文档中每个页面的说明。
Example llms.txt
# 示例产品文档

## 指南
- [快速开始](https://example.com/docs/start): 入门指南
- [安装](https://example.com/docs/install): 安装步骤

## 参考
- [API](https://example.com/docs/api): 接口列表和使用说明
这种结构化方法让 LLM 能够高效地在更高层面处理你的文档,并为用户查询定位相关对象,从而提升 AI 辅助文档搜索的准确性和速度。

llms-full.txt

llms-full.txt 文件将整个文档站点整合为一个单一文件,作为 AI 工具的 context,并由 LLM 流量进行索引。 Mintlify 会在你的项目根目录自动托管一个 llms-full.txt 文件。你可以在文档站点的 URL 末尾追加 /llms-full.txt 来查看该文件。 打开此站点的 llms-full.txt

自定义文件

要添加自定义的 llms.txtllms-full.txt 文件,请在项目根目录创建一个同名文件。添加自定义文件会覆盖同名的自动生成文件。删除自定义文件后,将恢复使用默认文件。 自定义的 llms.txtllms-full.txt 文件必须以网站标题作为一级标题(H1)。其他内容为可选。有关可选部分和最佳实践的更多信息,请参见 llms.txt 规范中的Format
I