Markdown を段階的に読む
いつ使うか
- •まず見出し構造を把握し、必要な章だけ抽出したいとき
- •章単位での引用・確認が必要なとき
- •数行程度の短い Markdown は通常読解で十分
前提
- •Python 3 が利用可能
- •スクリプト
scripts/md-index.pyを使用 - •対象の Markdown がローカルにある
基本手順(段階的読み込み)
- •見出しツリーを表示する
python3 scripts/md-index.py --tree path/to/doc.md - •読みたい見出し名を正確に選ぶ
- •セクションを抽出する
python3 scripts/md-index.py --section "見出し名" path/to/doc.md※ スキルディレクトリで実行するか、scripts/md-index.pyを絶対パスで指定する
推奨フロー
- •まずは大見出し(H1/H2)で
--tree - •必要な章だけ
--sectionで読む - •さらに細分化が必要なら小見出しで
--section
例
code
python3 scripts/md-index.py --tree README.md python3 scripts/md-index.py --section "Installation" README.md
注意点
- •
--sectionは見出し名の完全一致が基本。表記ゆれに注意する - •大小文字・全角半角・記号の差は区別される前提で一致させる
- •目的の見出しが見つからない場合は、見出しレベルや表記を見直す
トラブルシューティング
- •
python3: command not foundの場合は Python 3 をインストール - •
No input providedが出た場合は Markdown ファイルを指定するか stdin を渡す - •
scripts/md-index.pyが見つからない場合は作業ディレクトリかパスを確認 - •期待した内容が出ない場合は見出し名を再確認する