内容
- npmを使ってdoctocを入れた
- 目次（h1）は非表示にした
doctoc
目次のことを英語で「Table Of Contents」ということから、よく TOC と呼ばれるらしい
markdownからTOCを生成する方法はいろいろあるらしいが、ローカルにNPMを入れていたこともあり、doctoc を選択した
インストール
npm install -g doctoc
使い方
doctoc README.md
タイトルには目次を作らない
ひとつしかないタイトルの h1 タグにTOCを振っていたのでは、見た目がよろしくない。そこで上で生成した doc からタイトルを削除する方法を考える
公式では--notitleオプションをつけて実行するとうまく行くと書かれていたが、一度作った後だからか解決しなかった。
toc をつける範囲を限定する
一度doctoc README.mdをした後に自動で作られる
<!-- START doctor generated TOC please ....> <!-- DON'T EDIT THIS ... >
の上に、目次を作りたくない h1 セクション（# SOMETHING）を移動した
移動した後に再度doctoc README.mdを実行すると h1 の直後に目次が作られた
