GitbookでTOC(目次)をサクッと追加したい。それをPDFでも出力したい。
https://github.com/whzhyh/gitbook-plugin-toc
事前準備
参考サイト
Gitbookのインストール
npm install gitbook -g
gitbook-pdfのインストール
npm install -g gitbook-pdf
calibreのインストール
brew cask install calibre
ドキュメント作成
プロジェクトディレクトリの作成
mkdir gitbook
Gitbookの初期化
gitbook init
あとは、README.mdやSUMMARY.mdをごにょごにょ...
...で、ここからが本題!
gitbook-plugin-tocのインストール
プラグインのインストール
npm i gitbook-plugin-toc
book.jsonの作成
プロジェクトのルートに配置
book.json
{
"plugins": ["toc"],
"pluginsConfig": {
"toc": {
"addClass": true,
"className": "toc"
}
}
}
README.mdの編集
目次を挿入したい位置に <!-- toc -->
を追加
以上。
サーバ起動して http://localhost:4000 にアクセスすればHTMLで確認できる。
gitbook build
gitbook serve
PDFで出力してもちゃんと表示される。
gitbook pdf . readme.pdf