项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-09-16 · 当前星标 ★ 413
技术标签
使用教程
环境要求
- Node.js 18+
- 一个 VitePress 文档站
安装与启动步骤
-
1装插件
文档站是 VitePress 时用它。
npm install vitepress-plugin-llms --save-dev -
2在配置里启用
生成 llms.txt 与全文版本。
-
3构建后检查产物
确认路径在站点根目录且内容完整。
-
4上线后校验
用检查命令验证可访问性与格式。
npx llms-txt-check https://你的站点域名
如何确认成功
构建后根目录出现 llms.txt,链接可访问,且全文版本的条目数与文档页数一致
注意事项
- 它给文档站生成面向 AI 爬虫的索引文件,帮模型快速理解站点结构。
- 生成物要放在站点根目录才能被爬虫发现。
- 全文版本体积大,页数多时要注意构建时间。
- 内容更新后要重新构建,别让索引过期。
- 对非 VitePress 站点不适用。
核心亮点
- 构建时自动生成 llms.txt,无需手动维护索引文件
- 与 VitePress 配置集成,几行代码即可接入现有文档站
- 输出保留标题层级和链接结构,比直接抓 HTML 更适合 LLM 消费
不足之处
- 项目较新,边缘场景和复杂主题的兼容性待更多验证
- 文档和社区规模有限,遇到问题可参考的案例不多
适用场景
- 为开源项目文档站生成 llms.txt,方便 AI 助手准确回答使用问题
- 给企业内部知识库接入 RAG 时,快速产出结构化文本语料
- 让代码补全或 AI 编程工具更好地引用组件库文档
替代项目
docusaurus-plugin-llms、llms-txt
上一篇:Resume-Matcher
下一篇:tools
同类项目推荐
chatgpt-gemini-timeline
开源
给AI对话加文件夹和时间轴,找回历史不费劲
ChatGPT & Gemini:Add Folders, Timeline & Prompts. - 为 ChatGPT & Gemini 添加文件夹、···
awesome-spec-driven-development
开源
找全规范驱动开发资源,快速落地契约优先流程
A curated list of awesome resources for spec-driven development (SDD)
PPT-Design-Skill
开源
一句话生成4万种风格、可编辑的专业PPT
Precision PPT design skill for OpenCode/Claude Code/Codex, with 40,000+ styles, pixe···
ham_home
开源
AI 自动整理书签和标签页,搜索快人一步
Open-source, local-first web clipper & tab manager: save pages, text and images, sea···
admyral
开源
自定义控制持续自动监控,合规审计不再靠抽查
Admyral enables continuous control monitoring for any custom control
docmind-ai-llm
开源
本地大模型离线读文档,问答摘要不出网
DocMind AI is a powerful, open-source Streamlit application leveraging LlamaIndex, L···
ServiceNowDocs
开源
官方 ServiceNow 文档,直接喂给大模型做知识库
ServiceNow AI Platform documentation for LLM consumption.
vitepress-plugin-llms
开源
让 VitePress 文档一键变成 LLM 爱读的 llms.txt
A VitePress plugin for generating LLM-friendly documentation
slides_maker
开源
让 AI 帮你把论文代码变成能直接编辑的 PPT
Turn papers, code, and docs into presentation-ready, natively editable PPTX in Codex···