doctocを使ってreadmeに目次を作成する

thlorenz/doctoc: 📜 Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites.

doctocはreadmeに目次を作れる。
ドキュメントに目次があれば、readmeの移動が楽になる。

デフォルトだと、titleがデカデカで出てしまうので、--notitleを付けるとよい。

$ npx doctoc --maxlevel 3 --notitle readme.md

npxで一気に使っていいが、継続して更新していくつもりなら、huskyとlint-stagedを使ってコミット時に走らすのがいいだろう。

参考

自分のOSSのプロジェクトに導入した結果が下のような感じ。