markdownにドキュメントを書いていて目次を作ろうとしたとき何か楽にできる方法はないかな？と思って探してたどりついた方法をメモしておきます。
目次生成ツール「doctoc」
doctoc https://github.com/thlorenz/doctoc
なお、使い方の参考にさせていただいた記事はこちらです↓
Markdownに目次(TOC)を表示させる - tsunokawaのはてなダイアリー
使い方
- 次のコマンドを実行してdoctocをインストールする
-
npmを使います
-
npm install -g doctoc
- markdownの目次を入れたいか所に以下を挿入する
<!-- START doctoc -->
<!-- END doctoc -->
- markdownのディレクトリに移動してから、次のコマンドを実行して目次を生成する
- 「README」のところは対象のmarkdownのファイル名を指定します
doctoc README.md --github
- リスト形式で目次が生成されます
- 見出しが増えたり減ったり変更になった利した場合は、再度上記コマンドを実行することで更新されます