llms.txt 文件
为兼容代理提供的纯 Markdown 资源地图,可位于根目录或特定路径。本页介绍位置、v2 结构、发现和验证。
最近更新:
文件是什么
llms.txt 文件是一份 Markdown 文档,它为兼容的智能体映射精选资源,每个链接可附带说明。Jeremy Howard(Answer.AI)在 2024年9月 提出了这项约定;它不是强制标准。如果你想了解其概念和采用情况,请先阅读 什么是 llms.txt;本页只关注文件 本身。
它所在的位置
V2 允许将文件放在源站根目录 https://yourdomain.com/llms.txt,或更具体的路径, 例如 https://yourdomain.com/docs/llms.txt。最具体的适用文件 描述某个页面的范围。用 rel="describedby" 在 HTML 或 HTTP Link
header(如有可能)。配套的 llms-full.txt 可为明确支持该约定的客户端承载整合后的页面内容。
结构概览
- 一个 H1 ,内容为网站或项目名称。必需,位于第一行。
- 可选的引用块 ,位于 H1 之后:一段事实性摘要。
- 可选的自由格式 Markdown 正文,用于提供上下文(不得包含标题)。
- H2 分节,每个部分都是由以下内容组成的列表:
- [name](url): note项目。一个标题为Optional可以在编辑层面标注次要链接,不具有特殊的 v2 语义。
带注释示例的完整规则请参阅 格式参考.
最小有效示例
# Acme
> Acme is a hosted analytics platform for product teams.
## Documentation
- [Quickstart](https://acme.example/docs/start): install, init, first dashboard.
- [API reference](https://acme.example/docs/api): full endpoint catalogue.
## Optional
- [Blog](https://acme.example/blog): product updates and tutorials. 常见错误
- 含糊的相对 URL。 当文件可能被复制时,绝对链接更安全。
- 摘要中的营销文案。 引用块应保持客观。
- 倾倒整个站点地图。 该文件是精选映射,而非索引。
- 使用 HTML 而非 Markdown。 该文件必须是纯文本 Markdown。
- 使用错误的 MIME 类型提供文件。 使用
text/plain(UTF-8)。
正确提供它
在大多数技术栈中,这是 public 目录里的静态文件:请参阅各技术栈指南,了解
Next.js, Astro,
WordPress, Hugo 或
Cloudflare Pages。设置
Content-Type: text/plain; charset=utf-8 并设置较短缓存时间,以便更新及时传播。
常见问题
llms.txt 与 llm.txt 相同吗?
规范名称是 llms.txt (复数形式)。 llm.txt 是一种常见拼写错误;请使用规范名称提供文件。
该文件需要更新吗?
是的,就像站点地图一样:过时链接会削弱读取该文件的工具对它的信任。关键页面发生变化时,请重新生成该文件。
它应该多大?
该提案没有规定字节上限。请让文件聚焦于预期任务,测试你支持的客户端,并在有用时按实际作用域拆分为路径级文件。