llms.txt 与 llms-full.txt 是什么、怎么给文档站写一份:格式约定与 AI 编程工具读取用法

llms.txt 是放在网站根目录或子路径的纯 Markdown 索引文件(v2 规范),帮 AI 智能体跳过网页噪声按需读取文档;llms-full.txt 则是整站文档合并版。本文讲清格式顺序、生成工具与读取用法。

NNathaniel bigo··原创首发·AI 辅助撰写
11 分钟读完
资料核对于 2026-11-18 · 依据官方文档与公开资料整理 免费账号 账号

结论先说

  1. llms.txt 是给 AI 智能体看的「站点精简目录」:按 llmstxt.org(v2 规范)定义,放在网站根目录 /llms.txt 或子路径(如 /docs/llms.txt),用结构化 Markdown 给出项目简介与干净文档页链接,省去解析复杂 HTML 导航和脚本的开销。
  2. llms-full.txt 是社区与文档平台通行的「整站正文合集」:llms.txt 只放轻量索引供智能体按需跟进链接;llms-full.txt 则把整站核心文档拼成单个大文本文件,适合本地建索引或离线检索,但直接整份塞进对话容易撑满上下文窗口。
  3. v2 规范只有一级标题 # 项目名 是必填项,但各段落顺序固定:依次为 # 标题、> 一句话摘要、无标题补充说明、## 分类名 下的 名称: 说明 列表,以及约定的 ## Optional 次要链接分组。
  4. 配套页面建议提供同名 .md 纯文本版:规范建议在原网页 URL 后加 .md(如 page.html.md 或目录页加 index.md),并用 <link rel="alternate" type="text/markdown"> 或 HTTP Link: 头声明关联。
  5. 它不替代 robots.txt 和 sitemap.xml:robots.txt 管爬虫准入边界,sitemap.xml 罗列全量人类页面给搜索引擎,而 llms.txt 专供推理阶段的智能体按需查资料。
  6. 主力模型订阅与账号配套入口:跑通 MCP 工具链与多文件智能体编码依赖稳定的底层大模型配额,国内免境外卡自助开通可见本站 Claude Code 订阅页、ChatGPT Plus 充值页 与 AI 会员充值总览。

llms.txt 与站点索引文件对比

图:本站根据 llmstxt.org:The /llms.txt file, v2 整理的示意图

本文根据开放规范《The /llms.txt file, v2》(llmstxt.org)及主流大模型官方文档站实践整理,资料核对于 2026-11-18。配图为本站整理的示意图,不是界面截图。本站(bigolab.com)不是 llmstxt.org 官方网站。

适用于谁

  • 在开源库或大模型文档站看到 /llms.txt 和 /llms-full.txt,想知道两者有什么区别、该喂哪个给 AI 的开发者;
  • 维护内部或公开技术文档,想按标准格式写一份让编程智能体少出幻觉的文档负责人;
  • 想弄清它和 robots.txt、sitemap.xml 以及项目内 AGENTS.md 各管什么的读者。

一、为什么需要 llms.txt,它和 llms-full.txt 差在哪

人类逛文档站需要侧边栏、样式表和交互脚本,但编程智能体抓 HTML 时,这些标签只会浪费大量 token 并干扰提取精度。为此,OpenAI、Anthropic、Google Gemini 开发者文档以及 Chrome Lighthouse 的智能体浏览检查(Agentic browsing checks)都已引入 /llms.txt。

日常使用时,你会同时遇到两个文件名:

  • llms.txt(官方规范定义):体积很小,装得进一次普通对话上下文。模型先读这份总览判断该看哪一章,再去拉取对应章节的 .md 链接;
  • llms-full.txt(文档平台扩展约定):例如 Mintlify 托管站点和 OpenAI Codex 文档(learn.chatgpt.com/docs/llms-full.txt)会把所有文档正文直接拼进这一个文件。小项目直接复制很省事,大型框架动辄几百万字符,更适合拆块检索而不是整篇粘贴。长文本提问排布技巧见 长文档怎么问 AI。

二、怎么给文档站写一份标准的 llms.txt

按官方 v2 规范编写 llms.txt 的五个部分

图:本站根据 llmstxt.org:The /llms.txt file, v2 整理的示意图

v2 规范要求各部分严格按顺序书写,这样既方便大模型阅读,也方便普通程序用正则或解析器固定提取。可直接套用下面这份模板:

markdown
# Acme SDK

> Acme SDK 是一个基于 TypeScript 的服务端支付与对账客户端库,要求 Node.js 20 及以上版本。

重要边界说明:
- v3 版本接口与旧版 v2 不兼容,所有异步方法均返回 Result 对象而非直接抛出异常;
- 仅用于服务端环境,不支持在浏览器前端直接打包调用以防泄露密钥。

## 快速开始与核心接口

- [安装与初始化](https://docs.example.com/quickstart.html.md): 环境变量配置、客户端实例化与最小支付请求示例
- [Webhook 验签指南](https://docs.example.com/webhooks.html.md): 请求头签名核验步骤与幂等处理写法

## Optional

- [v2 升级 v3 迁移对照表](https://docs.example.com/migration-v3.html.md): 旧项目升级时的破坏性变更清单

编写和发布时的四个关键细节:

  1. 子路径就近覆盖原则:放在 /docs/llms.txt 就代表只覆盖 /docs/ 下的内容;若同一页面同时命中根目录和子目录两份文件,智能体优先采用路径更具体的那一份;
  2. 中间补充段不能出现标题:在 > 引用块之后、第一个 ## 二级标题之前,只能写普通段落或无序列表(常用来强调「不兼容某某语法」),不要穿插三级标题;
  3. ## Optional 的特殊含义:这是规范约定的保留分组名,告诉智能体「如果上下文预算紧张,这一节里的链接可以直接跳过」;
  4. 提供 .md 镜像页与 Link 响应头:把正文页同步生成一份 原路径.md 或 index.html.md,并在 CDN 或服务端加上 Link: </docs/quickstart.html.md>; rel="alternate"; type="text/markdown", </docs/llms.txt>; rel="describedby",无需改动原 HTML 就能让客户端自动发现。

如果你的文档站用的是现成框架,不必纯手写:Mintlify、GitBook、WordPress(Yoast SEO / AIOSEO)已支持自动输出,静态站可直接装 vitepress-plugin-llms 或 docusaurus-plugin-llms。写完初稿后,建议结合 用 ChatGPT 写 README 和技术文档 的核验思路,只把 llms.txt 发给一个新会话的智能体提问,测试它能否准确挑出目标链接。

三、在 AI 编程工具里怎么读取和利用 llms.txt

作为调用第三方新库的开发者,拿到对方官网的 llms.txt 后有三种高频用法:

  • 在 Cursor 里挂进文档索引:把目标库的 /llms.txt 或 /llms-full.txt 地址添加到 @Docs 自定义文档源,让补全和 Agent 引用最新接口;
  • 在 Claude Code 或 Codex 里按需拉取:在提示词里直接给出库文档的 /llms.txt 链接,让智能体先读目录再抓取对应章节的 .md 页面,或者搭配 Claude Code 配 Context7 MCP 查最新文档 自动注入版本化文档;
  • 与仓库内 AGENTS.md 分工:llms.txt 放在外部文档站给访问者读,而自己代码仓库里的构建命令和目录规范则写在 AGENTS.md 或 CLAUDE.md 里(见 AGENTS.md 怎么写)。

日常用 Claude Code、Codex 或 ChatGPT 处理新框架升级和长文档检索时,若免费额度不够用,可在本站查看 Claude Code 订阅充值 或 ChatGPT Plus 充值。

常见问题

问:放了 llms.txt 会禁止未列出的页面被爬虫抓取吗?

答:不会。llms.txt 只做主动推荐和上下文导航,没有任何访问拦截作用;控制爬虫准入依然靠 robots.txt。

问:为什么不按 RFC 8615 放在 /.well-known/ 目录下?

答:v2 规范专门解释过:/.well-known/ 只能由域名根目录控制,像托管在子路径下的 GitHub Pages 项目站根本没权限写根目录;允许在任意子路径放 llms.txt 才能像 index.html 一样谁发布谁维护。

问:列表项冒号后面的说明文字是必填的吗?

答:不是必填,单写 - 标题 也符合语法,但官方强烈建议加上英文冒号和简短说明,否则智能体光看标题很难判断是否值得花 token 点进去读。

问:配置好开发环境后,国内没有外币卡怎么开通 Claude 或 ChatGPT 编程订阅?

答:可在 本站充值中心 自助选购卡密开通 Claude Code(Pro / Max) 或 ChatGPT Plus / Pro,全程无需交出账号密码,支持开具增值税发票;实时价格与售后边界(封号不在质保范围)以对应商品页为准。

相关教程

参考资料

  • The /llms.txt file, v2(官方规范站)— https://llmstxt.org/
  • OpenAI Codex 官方文档全量索引 — https://learn.chatgpt.com/docs/llms-full.txt
  • Google Gemini API 官方文档索引 — https://ai.google.dev/gemini-api/docs/llms.txt

Nathaniel 的更多内容

  1. 01

    独立开发者用 ChatGPT + Codex 跑通产品全流程:市场验证、PRD、原型到代码上线复盘清单

    单人做独立产品最容易陷入「闭门写两个月代码上线零用户」或「AI 写到一半目录越改越崩」。本文整理「ChatGPT 负责市场验证、PRD 与复盘 + Codex 负责工程实现与测试」的五阶段双轨流程,附起手提示词与 7 项上线复盘清单。

    ChatGPTCodex0
  2. 02

    用 ChatGPT 批量生成规范文件命名规则、整理混乱目录树与合并零散发票抬头清单脚本

    面对满桌面的「新建文件夹」「最终版2」和上百张零散电子发票,手工改名抄台账耗时又容易漏重。本文分享先脱敏取样、再用 ChatGPT 生成带预演和回滚日志的本地 Python 脚本,离线安全完成目录整理与发票抬头合并去重的实战流程。

    ChatGPT0
  3. 03

    用 ChatGPT 做海外邮件营销(EDM)受众分层文案、A/B 主题行测试与防进垃圾箱自检

    做海外独立站或出海 SaaS 邮件营销(EDM),最怕千人一面群发被直接送进垃圾箱。本文结合 Gmail/Yahoo 批量发件人规范,梳理用 ChatGPT 设计受众分层文案、批量生成 A/B 主题行矩阵并开展发前垃圾词与合规自检的实战提示词。

    ChatGPT0
  4. 04

    用 ChatGPT 写 Notion Formula 2.0 公式、Obsidian Dataview 查询与 Airtable 自动化脚本

    给 Notion 数据库写多条件 Formula 2.0 公式、给 Obsidian 写 Dataview 动态看板,或在 Airtable 里写自动化脚本,经常因为一个小括号或类型不匹配报错半天。本文整理三大工具的通用上下文喂料规范与三套直接可复制的生成提示词。

    ChatGPT其他 AI 工具0
  5. 05

    用 ChatGPT 处理复杂 JSON / YAML / XML 字段映射、格式转换与校验规则编写实战

    对接第三方 API、迁移 Kubernetes 配置或解析政企 XML 报文时,手工对照几百行嵌套字段既慢又容易漏掉空值与类型边界。本文整理用 ChatGPT 完成字段映射表梳理、生成确定性转换脚本以及编写 JSON Schema / Pydantic / XSD 校验规则的实战流。

    ChatGPT其他 AI 工具0
  6. 06

    用 ChatGPT 准备本科/硕士毕业论文答辩:提炼答辩 PPT 结构、模拟导师犀利追问与 3 分钟自述稿

    毕业论文写完后,要在 3–5 分钟内讲清研究价值并顶住答辩评委的连环追问并不轻松。本文整理在严格遵守高校学术规范的前提下,用 ChatGPT 提炼答辩 PPT 结构、打磨 3 分钟口语自述稿并开展模拟导师犀利追问的排练流程与提示词。

    ChatGPT0

同产品的其他教程

  1. 01

    用 ChatGPT 速读英文产品手册、开源文档与 GitHub Issue 并沉淀团队中文内训手册

    团队引入海外 SaaS 工具或开源框架时,全英文文档晦涩冗长、真正的坑全藏在几十页 GitHub Issue 讨论里。本文分享速读拆解英文手册、归类 Issue 排障库以及重构团队中文内训 SOP 的完整实战流程。

    ChatGPT其他 AI 工具0
  2. 02

    用 ChatGPT 写油猴脚本(Tampermonkey)与浏览器书签小工具解决网页繁琐重复操作实战

    每天在后台系统里重复勾选几十个复选框、手工复制网页表格或清理遮挡阅读的侧边栏,既枯燥又浪费时间。本文分享不会写 JS 也能用 F12 配合 ChatGPT 写出油猴脚本与书签小工具的完整实战流程。

    ChatGPT其他 AI 工具0
  3. 03

    用 ChatGPT 写高质量 SQL 窗口函数(RANK / LAG / SUM OVER)做留存与漏斗分析实战

    做用户留存率、复购间隔与有序转化漏斗时,多层自连接既难读又拖垮数据库,窗口函数则是高效解法。本文整理数据库方言喂数规范、CTE 分层提示词以及用内置沙盒先验证再上线的完整实战流程。

    ChatGPT其他 AI 工具0
  4. 04

    ChatGPT 连接 Canva、Figma、Linear、Jira、Dropbox 等第三方应用搜不到数据或授权失效怎么办

    在 ChatGPT 接入 Canva、Figma、Linear、Jira 或 Dropbox 后,明明显示已连接却搜不到文件工单,或老提示授权失效怎么办?本文拆解账号错绑、OAuth 范围漏选、权限继承与管理员拦截 5 步排障法。

    ChatGPT其他 AI 工具0
  5. 05

    Anthropic Contextual Retrieval(上下文增强检索)是什么、怎么实现:给文档块自动补背景摘要结合缓存降失误率

    长文档切成小块后丢了公司名、年份和主语指代导致 RAG 频频搜错?本文按 Anthropic 官方技术文章详解 Contextual Retrieval 原理、官方公开评测失误率下降 49% 至 67% 的组合架构,以及用 Claude 提示词缓存低成本批量生成切片背景的完整 Python 代码。

    Claude其他 AI 工具0
  6. 06

    RAG 知识库回答不准怎么调优:切片大小(Chunking)、BM25 + 向量混合检索与 Rerank 重排序三步排查法

    搭好的 RAG 企业知识库一问具体型号、报错码或跨行表格就答非所问?本文按 OpenAI 与 Anthropic 官方检索文档,给出先隔离检索与生成故障、再按结构化切片(Chunking)、BM25 加向量混合召回(RRF)与 Rerank 重排序逐层调优的三步法。

    Claude其他 AI 工具0

0 条评论

登录 后参与评论

还没有评论,来抢沙发~