llms.txt 格式,规范参考
llms.txt 文件格式完整参考:必需和可选元素、Markdown 规则、链接语法、llms-full.txt 变体,以及验证文件的检查清单。
最近更新:
格式概览
llms.txt 是一个纯文本资源,使用 CommonMark Markdown。它可以位于源站根目录,也可以位于更具体的路径,例如 https://example.com/docs/llms.txt。最具体 且适用的文件会说明该范围。
兼容的编程助手、RAG
管道和研究智能体可以将该文件用作精选地图。仅发布文件并不能证明它已被发现或使用,因此请使用 rel="describedby"
(如适用),并测量你实际支持的客户端。
必需元素
2026年8月 提案定义了一个必需元素:
- H1 标题,第一行必须是 H1(
# Name),其中包含 项目或网站名称。
blockquote 摘要、说明性前言、H2 文件列表和链接备注都是可选的。
# Your Project Name
> One sentence describing what your project does and who it's for.
## Documentation
- [Getting Started](https://example.com/docs/start): Install and first steps.
- [API Reference](https://example.com/api): Full endpoint catalog.
## Optional
- [Changelog](https://example.com/changelog): Release history.
可选分节
各部分是 H2 标题 (##),后接 Markdown 链接的无序列表。常见章节名称包括:
- 文档,主要文档、指南和参考资料。
- 产品,营销页面、定价、状态。
- 示例,代码示例、教程和演示。
- 可选、变更日志、博客、GitHub,对 AI 的优先级较低。
- API,专门的 API 参考章节。
- SDK,各语言专用客户端库。
可选 仍然是辅助资源的清晰编辑标签,但 v2 不赋予它任何特殊的处理语义。
# Acme SaaS
> Acme SaaS helps teams automate their billing workflows with a no-code dashboard
> and a REST API supporting 40+ payment providers.
## Product
- [Overview](https://acme.com/product): Core capabilities and use cases.
- [Pricing](https://acme.com/pricing): Plans, limits, and enterprise options.
- [Status](https://status.acme.com/): Uptime and incident history.
## Documentation
- [Quickstart](https://acme.com/docs/quickstart): Set up in under 5 minutes.
- [API Reference](https://acme.com/docs/api): REST endpoints, auth, rate limits.
- [SDKs](https://acme.com/docs/sdks): Node, Python, Ruby, Go clients.
- [Webhooks](https://acme.com/docs/webhooks): Event payloads and retry policy.
## Examples
- [Node.js integration](https://acme.com/examples/node): End-to-end payment flow.
- [Python integration](https://acme.com/examples/python): Subscription management.
## Optional
- [Changelog](https://acme.com/changelog): Version history.
- [Blog](https://acme.com/blog): Product updates and tutorials.
- [GitHub](https://github.com/acme/acme-oss): Open-source components.
链接语法
每个链接都遵循 Markdown 语法 - [Title](URL): short description.
- 使用 绝对 URL ,包括协议(
https://). - 冒号后的描述是纯文本,应控制在约 120 个字符以内,并为 AI 提供有用信息,而不是堆砌关键词。
- 每个列表项一个链接,不要嵌套项目符号。
- 优先使用规范 URL(如果你的惯例是在末尾加斜杠,也应保留)。
llms-full.txt 变体
更广泛的生态系统在此处使用一个可选的配套文件 /llms-full.txt。而 llms.txt 是一个链接索引, llms-full.txt 包含 全文 这些链接页面的内容拼接在一起,并以 Markdown 格式呈现。
明确支持该约定的工具可能会请求 llms-full.txt 用于整合 上下文。代价是体积更大、更新更滞后、以及更高的安全暴露。
阅读专门的 llms-full.txt 指南 ,了解生成策略。
检查清单
- 文件在根目录或预期的作用域路径中提供
- 采用 UTF-8 编码的纯文本或 Markdown 媒体类型
- 以且仅以一个 H1 标题开头
- 可选的引用块和前言不包含标题
- 链接目标在其发布上下文中可以正确解析
- 可选的链接注释简洁且符合事实
- 文件大小与任务和经过测试的客户端相称
- 无 HTML 标签,无嵌套列表
- 已使用以下工具验证: llms.txt 验证器
常见错误
- 相对网址,
- [Docs](/docs)在 AI 爬虫抓取文件时将无法正确解析。始终使用绝对 URL。 - 缺少引用块,这不属于 v2 合规错误。仅当简短的客观摘要对目标客户端有帮助时才添加。
- 错误的 Content-Type,并以
text/html或者缺少 content-type 会导致 一些解析器拒绝该文件。 - 在描述中堆砌关键词,AI 模型会按字面读取这些内容。堆砌关键词会降低质量信号。
- 列出每个页面,精选最重要的 10 至 30 个链接。使用
sitemap.xml用于全面发现 URL。配套的llms-full.txt可能 为明确兼容的摄取工作流打包内容,但它不能替代 sitemap。
相关指南
- 如何创建 llms.txt,适用于任何技术栈的分步指南。
- llms-full.txt 指南,完整内容配套文件。
- 验证器,检查文件是否符合规范。
- 生成器,通过表单创建文件。
- 最佳实践,应包含什么以及应跳过什么。
- 哪些 AI 抓取工具会读取 llms.txt,采用情况。