GitHub Tips: Markdown に対して目次を作る方法 (古い情報)

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

手順

• Visual Studio Code を起動して、「表示」→ 「拡張機能」を選ぶ
• テキストボックスに 「markdown」と入力し、黄色の部分をクリックしてインストールする
  • 
• 「再読み込み」を選ぶ
  • 
• 目次を挿入したい場所で右クリックして、「Markdown TOC: Insert/Update」を選ぶ
  • 
• 以下のような画面になる
  • 
• 黄色のプレビューボタンを押す
  • 
• 以下のような画面でプレビューを確認できる
  • 

参考

https://qiita.com/bj1024/items/16ec641dc88f74028192

不具合情報

VSCodeのバージョン1.29.1だと、Markdown TOCで目次つくると、 autoって文字がごちゃて入ってきて目次がきれいに作れない問題が発生します。 https://github.com/sakura-editor/management-forum/issues/55

以下で回避策(workaround)が提示されています。

https://github.com/AlanWalk/markdown-toc/issues/65#issuecomment-438500104

回避策(workaround) 手順