萌萌哒草头将军 前言
今天给大家介绍一个非常实用的 VitePress 插件 —— vitepress-plugin-llms，它可以帮你自动生成 LLM（大语言模型）友好的文档格式，非常适合想让 AI 更好理解你文档内容的场景!
往期精彩推荐
- 优雅，太优雅了，NestJS 🔥 实在是太优雅了！🚀🚀🚀
- 🚀🚀 🚀 太棒了，有了它，终于不用翻阅屎山💩代码了！
- 什么❓你还在用 vue-devtools，快来试试 vite-plugin-vue-devtools ❤️ ，更加丝滑🛹，更加全能！🚀🚀
- 更多精彩文章欢迎关注我的公众号：萌萌哒草头将军
正文
随着大语言模型（LLM）的广泛应用，开发者们越来越关注如何让文档更容易被 AI 理解。vitepress-plugin-llms 就是为这个目标而生的，它能自动为你生成 .txt 格式的 LLM 友好文档，大大提升你的 VitePress 项目的 AI 可解析性。
快速安装
使用 pnpm 安装：
pnpm install vitepress-plugin-llms --save-dev
基本用法
在你的 .vitepress/config.ts 中引入并配置插件：
import { defineConfig } from 'vitepress'
import llmstxt from 'vitepress-plugin-llms'
export default defineConfig({
vite: {
plugins: [llmstxt()]
}
})
只需简单几行配置，插件会自动为你生成两类文件：
-
llms.txt：包含所有章节链接的索引文件 -
llms-full.txt：将整站文档内容合并到一个文件中，方便 LLM 一次性读取
这两个文件都会被输出到 .vitepress/dist 文件夹中，配合你部署后的站点即可使用。
自定义配置
如果你有特殊需求，可以配置插件参数。例如：
llmstxt({
generateLLMsFullTxt: false,
ignoreFiles: ['sponsors/*'],
customLLMsTxtTemplate: `# {title}\n\n{foo}`,
title: 'Awesome tool',
customTemplateVariables: {
foo: 'bar'
}
})
这个配置做了以下几件事：
- 关闭
llms-full.txt的生成 - 忽略
sponsors/目录下的所有文件 - 使用自定义模板生成
llms.txt文件 - 注入了两个自定义变量
{title}和{foo}
推荐配置：设置重定向
为了让 AI 访问 .md 和 .txt 地址都能成功，推荐 Nginx 新增配置重定向：
location ~ ^/(.*)\.md$ {
return 200 /$1.txt;
}
这能确保 .md 地址也能正确跳转到 .txt 文件，让 AI 抓取更加顺畅。
插件亮点
- 开箱即用，无需复杂配置
- 自动生成适合
LLM的精简Markdown文档 - 可自定义模板和变量，灵活度高
- 结构清晰，适配主流托管平台
- 遵循
llmstxt.org规范，文档生成更规范、更可控
生成的文档结构大致如下：
.vitepress/dist
├── llms-full.txt // 所有文档整合为一个文件
├── llms.txt // LLM 索引文件，包含章节链接
├── xxx.md // 原始 Markdown 文件
├── xxx.html // 普通 HTML 页面
无论你是希望提升 AI 对文档的解析能力，还是想构建一份结构更清晰的站点，vitepress-plugin-llms 都是一个非常轻量好用的选择。
最后
vitepress-plugin-llms 是一个非常实用的小工具，它让你的文档站点更容易被 AI 消化，适合个人项目、开源文档站、开发者博客等场景!
今天的分享就这些了，感谢大家的阅读，如果文章中存在错误的地方欢迎指正！
![[爱了]](/js/img/d1.gif)
![[尴尬]](/js/img/d16.gif)