2026年3月公開

Markdownの目次を自動生成

長いMarkdownファイルにはナビゲーションが必要です。見出しから生成される目次があれば、どんなドキュメントもスキャンしやすくなります。ShowMeMyMDは目次を自動的に生成します — タグ不要、プラグイン不要、CLIツール不要。

## 課題

Markdownには目次構文がない

Markdownには目次用の構文がありません。仕様に [TOC] タグはありません。対応しているツールもありますが、多くは未対応です。

そこで皆が回避策を使います。 markdown-toc や doctoc のようなCLIジェネレーターがファイルにTOC用のMarkdownを挿入します。VS Codeにはそのための拡張機能があります。GitHubはWeb上のREADMEファイル用に自動生成します。

どれも自動ではありません。ファイルを変更するか、ツールをインストールする必要があります。見出しを変更すると、何かを再実行するまでTOCが古くなります。

## ShowMeMyMDの対応

ファイルを開く。目次はすでにそこにある。

見出しのある任意の .md ファイルを開く — # から ###### まで — ShowMeMyMD がクリック可能な目次を自動的に生成します。

挿入するタグなし。インストールするプラグインなし。実行するCLIツールなし。設定なし。ファイルを開いてナビゲートするだけ。

ポイント

目次はレンダリング時に生成されます。 .md ファイルは決して変更されません。見出しを変更すれば、次にファイルを開いた時にTOCが瞬時に更新されます。

## なぜ重要か

長いドキュメントにはナビゲーションが必要

構造のあるドキュメントはすべてクリック可能なTOCの恩恵を受けます。何百行もスクロールする代わりに、必要なセクションにジャンプ。

READMEファイル

インストール、使い方、APIドキュメント、コントリビューティングセクションのあるオープンソースプロジェクト。必要な箇所に直接ジャンプ。

ドキュメント

技術仕様、APIリファレンス、ランブック。TOCがテキストの壁をナビゲーション可能なリソースに変えます。

議事録

議題、決定事項、アクションアイテム。ドキュメント全体を再読しなくても先週の決定を見つけられます。

技術仕様

アーキテクチャ決定、設計ドキュメント、RFC。複雑なドキュメントをセクションごとにナビゲート。

## 代替手段

Markdown TOCを取得する他の方法

手動TOC

見出しアンカーへのMarkdownリンクを手書きします。 [Installation](#installation) のようなものを各セクションごとに。書くのが面倒で、見出しを変更すると壊れ、自分でメンテナンスが必要です。

markdown-toc (npm)

TOCを生成してMarkdownテキストとしてファイルに挿入するCLIツール。動きますが、Node.js、npm install、見出しが変わるたびにコマンドの再実行が必要です。ソースファイルを変更します。

VS Code拡張機能

複数のVS Code拡張機能がTOC生成を追加します。VS Code内では動きますが、VS Codeを開く必要があります — ドキュメントをナビゲートするためだけにフルIDEを起動することになります。

GitHub

GitHubはWeb上のREADMEファイル用にTOCを自動生成します。ファイル名の横のハンバーガーアイコンをクリック。ただし、これはGitHub.comでのみ動作します — Mac上のローカルファイルでは使えません。

## シンプルな方法

ファイルを開くだけ

ShowMeMyMDは見出しから目次を自動的に生成します。ファイルの変更なし。非破壊的。 # から ######まで、あらゆる見出し構造に対応。

TOCは常に最新です。なぜなら、キャッシュされたスナップショットや古くなった挿入ブロックからではなく、現在のファイルから生成されるからです。

## 続きを読む

スクロールをやめて。ナビゲートしよう。

$2.99。買い切り。サブスクリプションなし。アカウント不要。

で入手Mac App Store