如何创建 llms.txt 文件
发布: · 更新:
编写一个 llms.txt 文件大约只需十分钟。本指南按顺序逐一讲解每个部分,最后给出一个你可以直接粘贴并按需修改的文件。
1. 从 H1 标题开始
第一行必须是单个 H1——也就是你的项目或网站名称。它是该格式中唯一严格要求的元素。
# Acme Docs
2. 添加引用块摘要
紧接在标题下方,添加一两句话的引用块。这是语言模型最先读取的上下文,所以要写得具体:说明这个网站是什么、面向谁。
> Acme is a payments API. This file links to the docs an LLM needs to integrate and debug Acme.
3.(可选)添加几行说明文字
在任何章节标题之前,你可以添加普通段落,提供额外的引导说明。这里不要使用标题——保持一两句话即可。
4. 将链接归入 H2 章节
每个章节是一个 H2 标题,后面跟着一个 markdown 列表。每一项都是一个链接,冒号后可附上可选的描述。
## Docs - [Quickstart](https://acme.com/docs/quickstart): Integrate in five minutes - [API reference](https://acme.com/docs/api): Every endpoint and parameter ## Examples - [Sample app](https://acme.com/examples/app): A working end-to-end example
使用绝对 https URL,并让描述聚焦于开发者或模型真正需要的信息——而不是营销文案。
5. 用 "Optional" 章节放置锦上添花的内容
名为 ## Optional 的小节是标注次要信息的约定——放那些在需要更短上下文时智能体可以跳过的链接。变更日志、博客文章和次要参考资料放这里。
6. 放在根目录——或放在它所覆盖的路径下
把文件放在 https://yourdomain.com/llms.txt,并以 Content-Type: text/plain 提供。它也可以放在子路径下,覆盖该路径之下的页面:/docs/llms.txt 描述 /docs/ 里的一切,而智能体会优先采用适用范围最具体的那个文件(参见规范 v2 变了什么)。大型站点通常还会发布一份把内容全部展开的 llms-full.txt。
7. 让页面指向它
为了让智能体不必猜测网址,请从你的页面用 <link rel="describedby" href="/llms.txt"> 声明该文件——或者使用等效的 Link: 响应头,在 CDN 配置里设置一次即可。
8. 发布前先验证
将你的域名粘贴到验证器中。它会检查结构、确认每个链接都能真正解析,并列出确切的修复项。目标是拿到 100/100。