面向文档站点的 llms.txt
发布:
文档站点是 llms.txt 的理想应用场景:人们不断地向 AI 工具询问“如何在你的产品里完成某件事”,而一份精心整理的文件能把这些模型直接引向正确的页面。
为什么文档站点受益最大
你的文档本身就是答案。llms.txt 让你能向模型递上一份干净的文档索引——入门指南、操作指南、API 参考——而不是任由它去爬取导航栏、搜索界面和营销页面。
根据站点结构生成
大多数文档站点都已经有一份 sitemap.xml。请把这些 URL 归类到几个合理的分区,而不是平铺罗列:
# Acme Docs > Documentation for the Acme API: setup, guides, and the full endpoint reference. ## Getting started - [Quickstart](https://acme.com/docs/quickstart): First request in 5 minutes - [Authentication](https://acme.com/docs/auth): API keys and scopes ## Reference - [Endpoints](https://acme.com/docs/api): Every endpoint and parameter ## Optional - [Changelog](https://acme.com/docs/changelog): Release history
链接到 Markdown 版本
许多文档框架(Docusaurus、MkDocs、Mintlify、GitBook 等)都能为每个页面提供 Markdown 或纯文本版本。请链接这些版本——page.md——这样模型解析的就是干净的内容,而不是带有导航和侧边栏的渲染后 HTML。
添加 llms-full.txt 以提供完整上下文
对于较大的文档集,可以再发布一份配套的 llms-full.txt,把全文内嵌其中,让智能体能在一次抓取中读取全部内容。同时让 llms.txt 保持为简洁的索引。
先整理,再校验
无论你是手写这份文件还是用插件生成的,都要审查输出结果——自动生成器往往会包含过多内容。可参阅 llms.txt 示例 了解常见写法,然后校验以确认结构正确、且每个链接都能正常解析。