wiki-llms-text について
Wiki ドキュメントから llms.txt と llms-full.txt を生成し、LLM が読み取りやすくするスキルです。リポジトリ情報の確認、仕様に沿った構成、ファイル生成、検証を案内します。
主な機能
- 01llms.txt と llms-full.txt の生成
- 02リポジトリ URL とブランチ情報の確認
- 03Wiki リンクのトピック別整理
- 04書式を保った Wiki 内容のインライン化
- 05リンクと生成ファイルの検証
活用シーン
- 01LLM による Wiki ドキュメントの発見準備
- 02内容をインライン化した文書リファレンスの作成
- 03公開前の llms.txt ファイルの確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ bklit/ bklit-ui --skill wiki-llms-textインストール後、Claude Code で/wiki-llms-textを入力して読み込まれたか確認します。
詳細
llms.txt ジェネレーター
llms.txt 仕様に従って、LLM が扱いやすい形式で Wiki ドキュメントにアクセスできる llms.txt ファイルと llms-full.txt ファイルを生成します。
このスキルが有効になる条件
- ユーザーが
llms.txtの生成を依頼する、または llms.txt 標準に言及する - ユーザーがドキュメントを「LLM フレンドリー」または「LLM が読み取りやすい」ものにしたい
- ユーザーが言語モデル向けのプロジェクト概要ファイルを依頼する
- ユーザーが
llms-full.txtまたはコンテキストを拡張したドキュメントに言及する
ソースリポジトリの解決(最初に必ず実行)
生成する前に、ソースリポジトリのコンテキストを解決してください。
- Git リモートを確認する:
git remote get-url originを実行します - ユーザーに尋ねる:「これはローカルのみのリポジトリですか、それともソースリポジトリの URL がありますか?」
- リモート URL →
REPO_URLとして保存します - ローカル → 相対パスのみを使用します
- リモート URL →
- デフォルトブランチを特定する:
git rev-parse --abbrev-ref HEADを実行します - 解決が完了するまで先へ進まないでください
llms.txt の形式(仕様準拠)
このファイルはllms.txt 仕様に従います。
# {Project Name}
> {Dense one-paragraph summary — what it does, who it's for, key technologies}
{Important context paragraphs — constraints, architectural philosophy, non-obvious things}
## {Section Name}
- [{Page Title}]({relative-path-to-md}): {One-sentence description of what the reader will learn}
## Optional
- [{Page Title}]({relative-path-to-md}): {Description — these can be skipped for shorter context}
主なルール
- H1 — プロジェクト名(必ず 1 つ)
- 引用ブロック — 簡潔で具体的な概要(必須)。このプロジェクト固有の内容にしてください。
- コンテキスト段落 — LLM に伝えないと誤解される可能性のある、一般には知られていない制約や事項
- H2 セクション — トピック別に整理し、それぞれに
[タイトル](URL): 説明形式の項目を記載します - 「Optional」H2 — 特別な意味があり、短いコンテキストが必要な場合は、このセクション内のリンクを省略できます
- 相対リンク — すべてのパスを Wiki ディレクトリからの相対パスにします
- 動的な内容 — すべての内容はテンプレートではなく、実際の Wiki ページから取得します
- セクションの順序 — 重要度の高い順にします:オンボーディング → アーキテクチャ → はじめに → 詳細解説 → Optional
説明の品質
| ❌ 悪い例 | ✅ 良い例 |
|---|---|
| 「アーキテクチャの概要」 | 「少なくとも 1 回の配信を保証するメッセージパッシングによって、Orleans のグレインがどのように通信するかを示すシステムアーキテクチャ」 |
| 「はじめに」 | 「前提条件、Docker Compose を使ったローカル開発環境のセットアップ、最初の API 呼び出しの手順」 |
| 「API リファレンス」 | 「認証要件、レート制限、リクエスト/レスポンスのスキーマを含む REST エンドポイント」 |
llms-full.txt の形式
llms.txt と同じ構成ですが、すべてのコンテンツをインラインで記載します。
# {Project Name}
> {Same summary}
{Same context}
## {Section Name}
<doc title="{Page Title}" path="{relative-path}">
{Full markdown content — frontmatter stripped, citations and diagrams preserved}
</doc>
インライン化のルール
- 各ページから YAML フロントマター(
---ブロック)を削除します - Mermaid 図を保持します —
```mermaidフェンスはそのまま残します - 引用を保持します — すべての
[file:line](URL)リンクはそのままにします - 表を保持します — すべての Markdown 表をそのままにします
- `` コメントを保持します — これらは図の出典情報を示します
前提条件
このスキルは、Wiki ページがすでに存在する場合(/deep-wiki:generate または /deep-wiki:page を使用して生成した場合)に最も効果を発揮します。Wiki がまだない場合:
- まず
/deep-wiki:generateの実行を提案します - または、README とソースコードのスキャンから(Wiki ページへのリンクを含めずに)最小限の
llms.txtを生成します
出力ファイル
次の 3 つのファイルを生成します。
| ファイル | 目的 | 見つけやすさ |
|---|---|---|
./llms.txt | ルートの検出用ファイル | llms.txt 仕様で定められた標準パスです。GitHub MCP の get_file_contents と search_code は、まずこのファイルを検索します。 |
wiki/llms.txt | Wiki 相対リンク | VitePress でのデプロイと Wiki 内ナビゲーション用です。 |
wiki/llms-full.txt | コンテンツをすべてインライン化したファイル | すべてのドキュメントを 1 つのファイルで必要とするエージェント向けの包括的なリファレンスです。 |
ルートの ./llms.txt から wiki/ 内のファイルへリンクします(例:[Guide](./wiki/onboarding/contributor-guide.md))。wiki/llms.txt では Wiki 相対パスを使用します(例:[Guide](./onboarding/contributor-guide.md))。
ルートに llms.txt がすでに存在し、deep-wiki によって生成されたものではない場合は、上書きしないでください。
検証チェックリスト
最終確認の前に、以下を確認してください。
-
llms.txt内でリンクされているファイルがすべて実在する -
llms-full.txt内のすべての<doc>ブロックに、空ではない実際の内容がある - 引用ブロックが一般的な定型文ではなく、このプロジェクトに特化している
- セクションが重要度順に並んでいる
- セクション間でページの重複がない
- 「オプション」セクションには、本当に任意の内容だけが含まれている
-
llms.txtが簡潔である(1~5 KB) -
llms-full.txtにすべての Wiki ページが含まれている
コメント
Markdown 対応