READMEに目次を作成してみた（doctoc）

概要

doctocを利用して、READMEで目次を作成する。

ゴール

対象読者

「READMEを書いているときに、見出し要素に応じた目次をめちゃめちゃ簡単に作りたい」
と少しでも思った方

前提

環境構築：Docker
バージョン管理：Github
Markdownを利用します。

内容

準備→作成手順の順番で説明します。

準備

READMEで、以下のように記載します。

# 目次1
## 目次1-1
...内容

# 目次2
## 目次2-1
...内容

目次を作成する手順

1. npmインストールを行う

npm install -g doctocを実行

2. READMEを改修

README内の「目次」に規定のコメントアウトを追加

# 目次
<!-- START doctoc -->
<!-- END doctoc -->

# 目次1
## 目次1-1
...内容

# 目次2
## 目次2-1
...内容

3. コマンドを実行

CLIで

dockerの場合

docker run --rm -it -v $(pwd):/usr/src jorgeandrada/doctoc --github

pwd...以下の部分は

/Users/user名/ディレクトリ名:/usr/src jorgeandrada/doctoc　--github

のように記載します。

ローカル環境の場合

doctoc README.md --github

を実行。

色々処理が流れるので、エディタなどでREADMEを確認すると...

のように、目次を生成してくれます！！

おまけ

VScodeでプレビューを見る方法（Mac）

Cmd + Shift + V

まとめ

目次があるREADMEは読みやすい。

参考