当ツールは、入力されたMarkdownテキストから見出し(#、##など)を自動で抽出し、ドキュメントの目次(TOC: Table of Contents)を即座に作成する無料ツールです。
README.mdや技術ブログなど、長文のドキュメントを執筆する際に、手動で目次を作ったりページ内リンクを設定したりする手間を大幅に削減できます。
以下の3ステップで簡単にMarkdownの目次を自動生成できます。細かな出力設定も直感的に行えます。
目次を作りたいMarkdown本文を左側の入力欄に貼り付けます。その後、上部の「抽出対象」から、どこまでの深さの見出し(H1〜H4)を目次としてピックアップするかを選択してください。
「リスト形式」や「内部リンク化」のチェックボックスを切り替えることで、用途に合わせた目次を作成できます。内部リンク化をオンにすると、クリックして各見出しへジャンプできるアンカーリンク付きの目次が生成されます。
設定が完了し、右側の出力結果エリアに目次が生成されたら、そのままコピーしてお使いのMarkdownファイルの先頭などに貼り付けてください。
テキストを貼り付けるだけで、複雑なMarkdown構造から見出しだけを正確にピックアップします。
H1からH4まで、どの深さの見出しを目次に含めるかを自由に選択できます。
GitHubなどで機能する、見出しへの内部リンク付き目次を自動的に生成します。
階層に応じたインデントやリスト記号(-)を自動で整理して出力します。
サーバーへのデータ送信は一切行われません。未公開の社内ドキュメントなども安心して処理できます。
リポジトリのREADME.mdが長くなり、ユーザーが読みやすいように目次(TOC)を設置したい方に。
Qiita、Zenn、はてなブログなどのMarkdown対応プラットフォームで、見やすい長文記事を執筆している方に。
社内Wikiや仕様書をMarkdownで管理しており、手動でページ内リンクのIDを合わせる作業に疲れた方に。
複雑な構造のドキュメントの全体像をパッと把握したい方に最適です。