跳转到正文

LLMs.txt ​

llms.txt 是放在站点根目录、给大模型读的索引文件。助手拿到它,就知道文档站有哪些页面、每页讲什么,可以只读需要的部分,而不是抓取整个站点的 HTML。

站点提供的文件 ​

文档站构建时会生成以下文件,部署后位于站点根目录:

路径内容
/llms.txt索引:库名、简介,以及所有页面的标题与链接
/llms-full.txt全部文档拼接成的单个文件,适合一次性喂给长上下文模型
/<类型>/<页面>.md单页 Markdown,例如 /components/button.md
/design.md设计令牌

<类型> 是 guide、components 或 hooks。组件和组合式函数页面里的 <demo> 标签已被替换为示例源码,助手读到的就是完整可运行的用法。

站点部署在子路径下时(例如 GitHub Pages 的 /<仓库名>/),上面的路径前面都要加上这个子路径。

使用 ​

把索引地址贴给支持读取网页的助手:

text
<站点地址>/llms.txt

只问某个组件时,直接给单页地址更省上下文:

text
<站点地址>/components/button.md

链接是相对还是绝对 ​

llms.txt 里的链接默认是站点根相对路径,例如 /components/button.md。需要绝对地址时,设置以下任意一项,生成时会拼上站点地址:

  • lib.config.ts 的 docsUrl,同时用于 IDE 提示里的文档链接。
  • 环境变量 LLM_SITE_URL,优先级更高,适合在部署流水线里按环境设置,例如预发布和正式站点使用不同地址。

生成 ​

bash
pnpm build:ai

文件写入 docs/public/,由 VitePress 复制到站点根目录。构建文档站时(pnpm --filter @plinth/docs build)会自动先执行一遍,平时不需要手动运行。环境变量 LLM_OUTPUT_DIR 可以改变输出目录。

这些文件已加入 .gitignore,不要提交,也不要手改。

和 Skills 的区别 ​

  • Skills 随包发布,离线可用,版本与已安装的包一致,适合日常写代码。
  • LLMs.txt 在线读取,永远指向站点当前部署的版本,适合临时提问,或助手不支持技能时使用。

两者来自同一份页面收集逻辑,内容一致。

写好可被读取的文档 ​

  • 页面要有标题。索引里的名称取自 frontmatter 的 title,没有时取第一个一级标题(# 标题)。
  • 示例用 <demo vue="./demo/basic.vue" /> 引入,不要在正文里只写“见下图”。助手看不到渲染结果,只能读到内联的源码。
  • 提示块(::: tip)会被转成引用块,可以放心使用。