llms.txt 文件,列出文档中的所有可用页面。该文件始终保持最新且无需维护。你也可以选择在项目根目录添加自定义的 llms.txt 文件。
在你的文档站点 URL 末尾追加 /llms.txt,即可查看你的 llms.txt。
打开此站点的 llms.txt
llms.txt 结构
llms.txt 是一个纯 Markdown 文件,包含:
- 以 H1 标题呈现的站点标题。
- 结构化的内容分区,包含指向文档中各页面的链接及其描述。
llms.txt 示例
llms-full.txt
llms-full.txt 文件会将你的整个文档站点合并为一个文件,作为 AI 工具的上下文,并会被大型语言模型的流量抓取和索引。
Mintlify 会在你的项目根目录自动托管一个 llms-full.txt 文件。将 /llms-full.txt 追加到你的文档站点 URL 后即可查看该文件。
打开此站点的 llms-full.txt。
自定义文件
llms.txt 或 llms-full.txt 文件,请在项目根目录创建对应的 llms.txt 或 llms-full.txt 文件。添加自定义文件会覆盖同名的自动生成文件。若删除自定义文件,将恢复使用默认文件。
你的自定义 llms.txt 或 llms-full.txt 文件必须包含一个网站标题,并以 H1 级标题标注。其他内容可选。有关可选部分和最佳实践的更多信息,请参见 llms.txt 规范中的格式。