GitHub Tips: Markdown に対して目次を作る方法

Visual Studio Code の Auto Markdown TOC プラグインを使うと簡単に目次を作成、更新できる。

メモ

• 紹介するプラグインを Markdown TOC → Auto Markdown TOC に変更 (2019/07/20)
• 古いプラグインに関する情報は こちら を参照
• 古いプラグインの場合 VSCodeのバージョン1.29.1 以降で TOC がうまく作れない不具合 があります
• 参考 https://github.com/sakura-editor/management-forum/issues/55
• Workaround が提示されているのですが、一向に Markdown TOC 側での 根本対策 がされたなかった。
• https://github.com/AlanWalk/markdown-toc/issues/65#issuecomment-513427063 のコメントで上記 fork したプラグインの情報が載っていたのでここのページで紹介する。

手順

• Visual Studio Code を起動して、「表示」→ 「拡張機能」を選ぶ
• テキストボックスに 「Hunter」(作者の名前です)と入力して検索し、Install ボタンをクリックしてインストールする (あるいは Auto Markdown TOC からプラグインをダウンロードしてインストールも可)
  • 
• 必要に応じて「Reload」(日本語設定だと「再読み込み」)を選ぶ
• 目次を挿入したい場所で右クリックして、「Markdown TOC: Insert/Update」を選ぶ
  • 
• 以下のような画面になる
  • 
• 黄色のプレビューボタンを押す
  • 
• 以下のような画面でプレビューを確認できる
  •