Visual Studio Code の Auto Markdown TOC プラグインという目次作成ツールが神な件

• 1. Markdownの目次を自動的に書いてくれる件について
  • 1.1. Overview
  • 1.2. 前提条件
  • 1.3. 使い方
  • 1.4. 上手く目次ができないんだけど！？
• 2. おわりに

1. Markdownの目次を自動的に書いてくれる件について

上司から「Markdownで目次作る時、これ使うと幸せになれるよ」って紹介されたやつです。幸せになれましたので、この幸せな気持ちを共有します。

1.1. Overview

Markdownでドキュメントを作成している時、目次を作成しますよね？（画像のような）

この目次、自動的に記述してくれます。そして、見出しの番号も自動です。びっくり！
それが、Visual Studio Codeプラグイン「Auto Markdown TOC」です。

1.2. 前提条件

• これまで10年近く、設計書はExcel方眼紙（神Excel）か、良くてWordでした
• Markdown歴１ヶ月です
• Visual Studio Code バージョン: 1.41.1
• macOS Catalina 10.15.3

1.3. 使い方

1. 手順としては、こちら に記載の通りに実施していただければ大丈夫です。

2. 目次を入れたい箇所で右クリック→「Auto Markdown TOC: Insert/Update [^M T]」をクリック

1. すると、目次が作成されます！しかも！見出しに番号が付与されます！

1. 目次を作成した後に見出しを作る時も、

1. 勝手に番号が付与されます！

1.4. 上手く目次ができないんだけど！？

僕が詰まったポイントを共有しますね。

• 目次に見出し番号が付かん！

設定を変えてあげました。

1. command + , で設定を開いて「markdown-toc」で検索してください。
2. 「Detect And Auto Set Section」と「Ordered List」にチェックがついてる状態にしました。チェックを外すと見出し番号が出なくなりました。お好みで。

• 改行が変！

なんか改行コードが変かもしれないです。

1. command + , で設定を開いて「eol」で検索してください。
2. Eolの改行コードがautoとなってるので変えてください（Macは\n、Winは\r\nらしいです）。

2. おわりに

これからMarkdownでのドキュメント作成に慣れていきたいと思いますので、
記事の内容に不備・改善点ありましたらめっちゃ教えてください。
読んでいただき、ありがとうございました。