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 等大型專案使用。

相關

  • 專案
  • 專案
  • 專案
  • 專案
  • 專案