okineadev/vitepress-plugin-llms

📜 A VitePress plugin for generating LLM-friendly documentation

何を解決するか

従来のウェブサイトのドキュメントは、大規模言語モデル(LLM)が効率的に処理できるように設計されていないことが多く、重く、ごちゃついている。このプラグインは、VitePressのドキュメントを、LLMの消費に最適化された、シンプルで洗練されたMarkdown形式に変換する。

動作方法

Viteプラグインとして統合され、ビルドプロセス中にサイトのページのLLMフレンドリーなバージョンを自動生成する。llmstxt.orgの標準に従い、以下のファイルを生成する:

  • llms.txt: すべてのドキュメントセクションへのリンクを含むメインインデックスファイル。
  • llms-full.txt: サイト全体のドキュメントが1つのコンパイル済みファイルにまとめられたもの。
  • 各ページ用の個別の .md ファイル。

また、<llm-only><llm-exclude> という特別なタグを提供し、AIモデル専用の指示を含めるか、AIバージョンから人間向けのコンテンツを非表示にすることができる。

対象ユーザー

VitePressを使ってプロジェクトのドキュメントをホストしている開発者や技術ライターで、AIエージェントやLLMにとってよりアクセスしやすく、有用なドキュメントを提供したい人。

特徴

  • ゼロ構成: インストール後すぐに動作する。
  • コンテンツ制御: <llm-only> を使ってAI専用の指示を提供し、<llm-exclude> を使ってLLM向けに不要な情報を削除できる。
  • 標準準拠: llmstxt.orgの標準に準拠している。
  • ユーザー向けツール: 見出しに「Markdownとしてコピー」や「Markdownとしてダウンロード」のボタンをオプションで追加可能。
  • 広範な採用: Vite、Vue.js、Vitestなど主要プロジェクトで使用されている。

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト