update-markdown-file-index について
指定フォルダー内のファイル索引を Markdown ファイルに反映するスキルです。既存の文書構造を確認し、適切な形式を選んで、生成した Markdown を検証します。
主な機能
- 01既存の Markdown 構造を確認
- 02パターンでファイルを検索
- 03索引の作成と更新
- 04ファイル情報の抽出
- 05書式の維持と相対パスの使用
- 06Markdown 構文の検証
活用シーン
- 01Markdown 文書内のフォルダー索引を管理
- 02リポジトリ変更後にファイル一覧を更新
- 03ファイルをリスト、表、分類で整理
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ github/ awesome-copilot --skill update-markdown-file-indexインストール後、Claude Code で/update-markdown-file-indexを入力して読み込まれたか確認します。
詳細
Markdown ファイルインデックスの更新
Markdown ファイル ${file} を、フォルダ ${input:folder} 内のファイルのインデックス/表で更新します。
プロセス
- スキャン: 対象の Markdown ファイル
${file}を読み取り、既存の構造を把握します - 検出: 指定されたフォルダ
${input:folder}内でパターン${input:pattern}に一致するすべてのファイルを一覧表示します - 分析: 更新すべき既存の表/インデックスセクションが存在するかを特定し、または新しい構造を作成します
- 構造化: ファイルの種類と既存のコンテンツに基づいて、適切な表/リスト形式を生成します
- 更新: 既存のセクションを置き換えるか、ファイルインデックスを含む新しいセクションを追加します
- 検証: Markdown 構文が有効であり、書式が一貫していることを確認します
ファイル分析
検出された各ファイルについて、以下を抽出します:
- 名前: コンテキストに応じて拡張子付きまたは拡張子なしのファイル名
- 種類: ファイル拡張子とカテゴリ(例:
.md、.js、.py) - 説明: 先頭行のコメント、ヘッダー、または推測される目的
- サイズ: 参照用のファイルサイズ(任意)
- 更新日時: 最終更新日(任意)
表構造のオプション
ファイルの種類と既存のコンテンツに基づいて形式を選択します:
オプション 1: シンプルなリスト
## Files in ${folder}
- [filename.ext](path/to/filename.ext) - Description
- [filename2.ext](path/to/filename2.ext) - Description
オプション 2: 詳細な表
| File | Type | Description |
|------|------|-------------|
| [filename.ext](path/to/filename.ext) | Extension | Description |
| [filename2.ext](path/to/filename2.ext) | Extension | Description |
オプション 3: カテゴリ別セクション
ファイルを種類/カテゴリ別にグループ化し、個別のセクションまたはサブ表に分けます。
更新戦略
- 🔄 既存の更新: 表/インデックスセクションが存在する場合、構造を維持したままコンテンツを置き換えます
- ➕ 新規追加: 既存のセクションがない場合、最適な形式を使用して新しいセクションを作成します
- 📋 保持: 既存の Markdown 書式、見出しレベル、ドキュメントの流れを維持します
- 🔗 リンク: リポジトリ内のファイルリンクには相対パスを使用します
セクションの特定
以下のパターンを持つ既存のセクションを探します:
- 以下を含む見出し: 「index」、「files」、「contents」、「directory」、「list」
- ファイル関連の列を持つ表
- ファイルリンクを含むリスト
- ファイルインデックスセクションを示す HTML コメント
要件
- 既存の Markdown 構造と書式を保持すること
- ファイルリンクには相対パスを使用すること
- 利用可能な場合はファイルの説明を含めること
- デフォルトではファイルをアルファベット順に並べ替えること
- ファイル名の特殊文字を処理すること
- 生成されたすべての Markdown 構文を検証すること
コメント
Markdown 対応