okineadev/vitepress-plugin-llms
📜 A VitePress plugin for generating LLM-friendly documentation
解决的问题
传统的网站文档通常对大型语言模型(LLMs)来说过于沉重和杂乱,难以高效处理。此插件将 VitePress 文档转换为原始、精简的 Markdown 格式,专为 LLM 消费优化。
工作原理
作为 Vite 插件集成,在构建过程中自动为您的网站页面生成 LLM 友好的版本。它遵循 llmstxt.org 标准,生成以下文件:
llms.txt:包含所有文档部分链接的主索引文件。llms-full.txt:包含整个网站文档的单个合并文件。- 每个页面的独立
.md文件。
它还提供特殊标签(<llm-only> 和 <llm-exclude>),允许作者为 AI 模型包含特定指令,或从 AI 版本中隐藏面向人类的内容。
适用人群
使用 VitePress 托管项目文档的开发者和技术写作者,希望让文档对 AI 代理和 LLM 更加可访问和有用。
特色亮点
- 零配置:安装后开箱即用。
- 内容控制:使用
<llm-only>提供 AI 专用指令,使用<llm-exclude>移除对 LLM 无用的噪声内容。 - 标准化:遵循 llmstxt.org 标准。
- 面向用户的工具:为访问者提供可选的「复制为 Markdown」和「下载为 Markdown」按钮。
- 广泛采用:已被 Vite、Vue.js 和 Vitest 等大型项目使用。
相关
- 项目
- 项目
- 项目
- 项目
- 项目