llms.txt 文件,列出文档中的所有可用页面。该文件始终保持最新且无需维护。你也可以在项目根目录添加自定义的 llms.txt 文件。
在文档站点的 URL 后追加 /llms.txt 即可查看你的 llms.txt。
打开此站点的 llms.txt。
llms.txt 结构
llms.txt 文件是一个纯 Markdown 文件,包含:
- 以 H1 标题形式呈现的站点标题。
- 结构化内容部分,包含链接以及文档中每个页面的说明。
description 字段。没有 description 字段的页面将在 llms.txt 中显示,但不含说明。
Example llms.txt
llms-full.txt
llms-full.txt 文件会将你的整个文档站点整合为一个文件,供 AI 工具作为 context 使用,并由 LLM 流量进行索引。
Mintlify 会在你的项目根目录自动托管一个 llms-full.txt 文件。你可以在文档站点的 URL 末尾追加 /llms-full.txt 来查看该文件。
打开此站点的 llms-full.txt
自定义文件
llms.txt 或 llms-full.txt 文件,请在项目根目录创建同名文件。添加自定义文件会覆盖同名的自动生成文件。删除自定义文件后,将恢复使用默认文件。
自定义的 llms.txt 或 llms-full.txt 文件必须包含一个以 H1 标题呈现的站点标题。其他内容为可选。有关可选部分和最佳实践的更多信息,请参阅 llms.txt 规范中的Format。