llms.txt
每个 Jamdesk 网站都会自动生成 llms.txt 和 llms-full.txt,帮助 AI 工具理解你的文档。
如果你希望 ChatGPT、Claude 或 Copilot 等 AI 工具准确回答有关你产品的问题,它们需要结构化访问你的文档,而不只是依赖训练数据中的内容。
每个 Jamdesk 网站都会根据 llmstxt.org 规范生成 llms.txt 和 llms-full.txt。AI 工具会读取这些文件,而不是逐个抓取页面。
Google 现在会将 llms.txt 纳入 Lighthouse 的智能代理浏览检查。发布有效 llms.txt 的网站更容易被 AI 代理发现,Google 自身也越来越多地在为 AI 生成答案排名内容时参考这一点。Jamdesk 免费提供此功能。
查看你的评分。 使用免费的 AI Score 工具,了解任意文档网站对代理的就绪程度。发布有效的 llms.txt 是它检查的首要项目之一。此外,还有一个 AI Score Chrome 扩展程序,可在浏览网站时为其评分。
Jamdesk 生成的内容
| 文件 | 内容 |
|---|---|
llms.txt | 页面标题、描述和 URL(结构化目录) |
llms-full.txt | 集中在单个文件中的完整文档内容 |
Jamdesk 会在构建时生成这两个文件,并通过与你的文档相同的 CDN 提供服务。
验证文件
首次构建后,检查文件是否存在:
如果你的文档位于域名根目录(例如 docs.acme.com 或 acme.jamdesk.app):
curl https://docs.acme.com/llms.txt
curl https://docs.acme.com/llms-full.txt文件格式
llms.txt 文件会列出每个页面的标题、描述和 URL,并按照与你的导航对应的分组进行组织:
# Your Project Documentation
> Documentation for Your Project
## Get Started
- [Getting Started](https://your-project.jamdesk.app/getting-started): Set up your first project in 5 minutes
- [Configuration](https://your-project.jamdesk.app/configuration): Configure your project settings
## API Reference
- [Authentication](https://your-project.jamdesk.app/authentication): How to authenticate API requests
llms-full.txt 文件包含每个页面的完整 Markdown 内容,并通过标题标记页面边界后进行拼接。
结构
llms.txt 遵循 llmstxt.org 提出的规范:包含 H1 标题、块引用摘要,以及以 ## 分组的 Markdown 链接形式呈现的导航标签页和分组。
多语言网站
包含多种语言的网站会为每种语言分别生成一组文件,以便 AI 工具只获取所需语言的内容。对于同时提供英语(默认语言)和法语的网站:
| URL | 内容 |
|---|---|
/llms.txt | 英文索引,末尾包含指向其他语言索引的链接 |
/en/llms.txt | 与 /llms.txt 相同的文件 |
/fr/llms.txt | 法文索引,并链接回其他语言 |
/llms-full.txt | 按顺序包含每种语言的完整内容 |
/en/llms-full.txt | 仅包含英文页面的完整内容 |
/fr/llms-full.txt | 仅包含法文页面的完整内容 |
根目录的 llms-full.txt 会保留所有语言,因此已经读取该文件的工具不会看到变化。当代理只需要某种语言时,请将其指向该语言专属的文件:
curl https://jamdesk.com/docs/fr/llms-full.txt
语言版本至少包含一个页面后,该语言才会获得专属文件。只有一种语言的网站只保留根目录文件。
每个页面上的代理指令
每个页面还包含一条不可见且屏幕阅读器不会朗读的备注,指向 llms.txt,每个 Markdown 导出文件也会以一个指向该索引的块引用链接开头。访问 HTML 的代理无需抓取页面,就能找到 Markdown 路径。
构建方式
- 在构建时与 HTML 一起生成
- 通过 CDN 提供服务,并采用与文档相同的缓存策略
- 每次构建时自动更新
- 无需配置;默认包含所有页面
关闭 llms.txt
llms.txt 和 llms-full.txt 默认会发布。如果你不希望 AI 工具获取你的内容,可以在 docs.json 中将 seo.ai.llmsTxt 设置为 false:
{
"seo": {
"ai": {
"llmsTxt": false
}
}
}下一次构建时,Jamdesk 会跳过这两个文件,包括每种语言的副本;线上 /llms.txt 和 /llms-full.txt URL 会返回 404。
AI 获取与搜索索引是相互独立的控制项。 seo.ai.llmsTxt 仅控制 AI 工具读取的 llms.txt/llms-full.txt 文件。它不会改变搜索引擎为你的网站建立索引的方式;索引方式由 robots 元数据和每个页面的 noindex 控制。页面可以被 Google 编入索引,同时排除在 AI 获取范围之外,反之亦然。
AI 爬虫
Jamdesk 默认的 robots.txt 允许所有主要 AI 爬虫(Claude、ChatGPT、Copilot、Gemini)访问。你的文档开箱即可被 AI 工具访问。
sitemap.xml 会列出供搜索引擎抓取和建立索引的 URL。它不包含任何内容,只有链接和最后修改日期等元数据。
llms.txt 专为 AI 模型设计。它包含页面标题、描述,以及(在 llms-full.txt 中)实际内容。AI 工具可以读取完整文件来理解你的文档,无需发出多个 HTTP 请求。
