llms.txt：让AI更懂你的文档，VitePress插件一键生成

核心洞察

这篇文章最有意思的是 llms.txtA standardized file format that allows website owners to communicate AI training and usage policies to AI crawlers, language models, and AI-driven search engines. 这个标准，它有点像 robots.txtA text file that instructs web crawlers which pages or files to access or ignore on a website.，但面向的是大模型。插件能自动生成文件，省不少事。不过说实话，目前这个标准还比较小众，后续能不能被主流 AI 工具广泛支持，才是关键。

---

“怎么让 AI 看懂我的文档？”这个问题越来越多开发者遇上了。费了好大劲写好的技术文档，到了 AI 那里就跟没看见似的，这滋味不好受。llms.txt 就是冲着这个痛点来的一个新标准，它就像你和 AI 之间的中间人，能让 ChatGPT、Claude 这些 AI 工具更准确地理解你的网站内容。这篇文章带你看看这个不起眼但挺有用的标准，还有怎么用 vitepress-plugin-llms为VitePress文档网站自动生成llms.txt和llms-full.txt文件的插件。 插件，给你的 VitePress基于Vue的静态网站生成器，常用于构建技术文档网站。 文档加上这个能力。

核心结论

1. llms.txt 是专门为大语言模型设计的标准化文件，通常放在网站根目录（如 https://example.com/llms.txt），内容包含网站标题、描述和内容目录，另有扩展版本 llms-full.txt 存放全部内容。

2. vitepress-plugin-llms 插件专为 VitePress 文档网站设计，可自动生成 llms.txt 和 llms-full.txt，支持自定义标题、描述和忽略特定文件，并在 Netlify 部署时需要创建包含 4 条重定向规则的 _redirects 文件。

3. 在 Wot Design Uni 组件库文档中，通过执行 pnpm add vitepress-plugin-llms -D 安装插件，并在 VitePress 配置文件（config.mts）的 vite.plugins 中添加 llmstxt()，同时创建了 docs/public/_redirects 文件以实现 Netlify 部署支持。

4. 引入该插件后，可提升文档在 AI 工具中的可发现性、减少 AI 对组件文档的误读，并提前适配 llms.txt 标准以增强未来兼容性，从而扩大项目的技术影响力。

什么是 llms.txt？

llms.txt 是专门给大语言模型（LLMs）用的一个文本文件。跟 robots.txt 类似，不过目的不一样。robots.txt 告诉搜索引擎爬虫哪些页面能爬，而 llms.txt 是给 AI 工具提供网站内容的结构化信息，帮 AI 更好地理解和索引你的内容。

文件名里的“llms”就是“Large Language Models”的缩写，意思就是这文件是专门给大语言模型准备的。

llms.txt 的由来

ChatGPT、Claude 这些 AI 工具越来越火，开发者都希望它们能正确理解和索引自家文档。但 AI 在抓取和理解网站内容时会遇到几个问题：

1. 网站结构复杂，AI 很难搞清楚内容之间的关系。
2. 内容可能分散在多个页面，AI 拿不到完整的信息。
3. 有些页面是动态生成的，AI 抓起来有困难。

于是，一些开发者和 AI 公司开始琢磨有没有一种标准化的方式，让网站所有者主动给 AI 提供结构化的内容信息。这就是 llms.txt 的来头。

llms.txt 的规范

llms.txt 文件通常放在网站根目录，比如 https://example.com/llms.txt。内容格式比较灵活，但一般会包含这几部分：

1. 网站标题和描述：简单说下网站的主题和内容。
2. 内容目录：列出主要页面和链接。
3. 内容摘要：提供网站主要内容的概括说明。

另外还有一个扩展版本叫 llms-full.txt，里面放了网站的全部内容，让 AI 能拿到所有信息。

下面是一个简单的 llms.txt 示例：

# 我的技术博客

这是一个关于前端开发的技术博客，主要分享 Vue、React 和 TypeScript 相关的技术文章。

## 文档目录

- [首页](/)
- [Vue 教程](/vue)
- [React 教程](/react)
- [TypeScript 教程](/typescript)
- [关于我](/about)

llms.txt 的作用

llms.txt 给 AI 工具提供了一套统一的方式来获取和理解网站内容。主要作用包括：

1. 提高 AI 理解准确性：结构化内容信息帮 AI 更准确地理解网站。
2. 增强 AI 回答质量：基于更完整的信息，AI 的回答更准确、更有深度。
3. 控制 AI 访问内容：网站所有者能主动决定给 AI 看哪些内容。
4. 减少 AI 抓取负担：AI 直接拿到结构化内容，不用反复爬整个网站。

vitepress-plugin-llms 插件介绍

vitepress-plugin-llms 是专为 VitePress 文档网站设计的插件，能自动生成 llms.txt 和 llms-full.txt 文件，让你的 VitePress 文档更容易被 AI 工具理解和索引。

插件特性

• 自动生成 llms.txt 和 llms-full.txt
• 支持自定义网站标题和描述
• 支持自定义模板变量
• 支持忽略特定文件
• 支持 Netlify 部署

安装和使用

安装插件：

npm install vitepress-plugin-llms -D
# 或者使用 pnpm
pnpm add vitepress-plugin-llms -D

在 VitePress 配置文件中加上插件：

// docs/.vitepress/config.js
import { defineConfig } from 'vitepress'
import llmstxt from 'vitepress-plugin-llms'

export default defineConfig({
  // ... 其他配置
  vite: {
    plugins: [
      llmstxt()
    ]
  }
})

如果用的是 Netlify 部署，还得创建一个 _redirects 文件：

/llms-full.md    /llms-full.txt 200!
/llms-full.txt   /llms-full.txt 200!
/llms.md         /llms.txt 200!
/llms.txt        /llms.txt 200!

Wot Design Uni 项目中的应用

在 Wot Design Uni 组件库的文档项目中，我们引入了 vitepress-plugin-llms 插件，为了让 AI 工具能更好地理解和索引文档内容。

引入过程

1. 安装插件：

pnpm add vitepress-plugin-llms -D

2. 在 VitePress 配置文件里添加插件配置：

// docs/.vitepress/config.mts
import { defineConfig } from 'vitepress';
import viteCompression from 'vite-plugin-compression'
import { fileURLToPath, URL } from 'node:url'
import { MarkdownTransform } from './plugins/markdown-transform'
import enUS from './locales/en-US'
import zhCN from './locales/zh-CN'
import llmstxt from 'vitepress-plugin-llms'

export default defineConfig({
  vite: {
    plugins: [
      MarkdownTransform(),
      viteCompression({
        verbose: true,
        disable: false,
        threshold: 10240,
        algorithm: 'gzip',
        ext: '.gz',
      }),
      llmstxt()
    ],
    // ... 其他配置
  },
  // ... 其他配置
})

3. 创建 Netlify 重定向规则文件：

// docs/public/_redirects
/llms-full.md    /llms-full.txt 200!
/llms-full.txt   /llms-full.txt 200!
/llms.md         /llms.txt 200!
/llms.txt        /llms.txt 200!

引入此插件的作用

引入 vitepress-plugin-llms 插件后，Wot Design Uni 项目得到了几点好处：

1. 提升文档可发现性：AI 工具更容易找到并索引我们的组件文档，用户在 AI 工具里问相关问题，更容易搜到 Wot Design Uni 的信息。

2. 增强用户体验：用户用 ChatGPT、Claude 时，能拿到更准确、更详细的组件信息，少走弯路。

3. 减少误解：结构化文档信息能降低 AI 对 Wot Design Uni 组件的误读，保证用户拿到的指导是正确的。

4. 扩大影响力：越来越多开发者靠 AI 工具找技术资料，让 AI 更好理解文档，就相当于给项目做了推广。

5. 未来兼容性：AI 技术在发展，llms.txt 标准可能会被更广泛地支持。提前做这一步，将来文档在 AI 生态里不至于掉队。

总结

写完这篇，其实没啥好总结的。llms.txt 给 AI 工具提供了一种统一的内容获取方式，vitepress-plugin-llms 插件让 VitePress 文档轻松支持这个标准。在 Wot Design Uni 项目里加上这个插件后，AI 能更好地理解和索引文档，用户也能得到更准确的信息。

随着 AI 继续发展，llms.txt 标准可能会被更多工具支持。对开发者来说，主动引入这个标准，就是让文档在 AI 时代保持好用的一个提前准备。

---

本文由 Wot Design Uni 团队 原创发布，欢迎关注我们的 GitHub 仓库，给个 Star 支持一下！

常见问题（FAQ）

llms.txt是什么？和robots.txt有啥区别？

llms.txt是专为大语言模型设计的文本文件，提供网站结构化信息，帮助AI理解内容。与robots.txt不同，robots.txt控制爬虫抓取，而llms.txt直接给AI提供内容目录和摘要。

如何在VitePress文档中自动生成llms.txt？

使用vitepress-plugin-llms插件。安装后，在VitePress配置文件的vite.plugins中添加llmstxt()即可自动生成llms.txt和llms-full.txt。若部署Netlify，需创建_redirects文件。

llms.txt对AI工具有哪些好处？

提高AI理解网站内容的准确性，增强回答质量；让网站所有者控制AI访问的内容；减少AI抓取负担，直接获取结构化信息；提升文档在AI工具中的可发现性。