amenoci / poppin

パスワード管理のDBアプリケーション
0 stars 0 forks source link

Feature/7/introduce toc plugin for gitbook #13

Closed amenoci closed 5 years ago

amenoci commented 5 years ago

7 の対応

issueにも記載の通り、https://github.com/JustPilz/gitbook-plugin-etoc-plus を導入する
このpluginは対象のマークダウンのファイルに特に何も追記しなくても、pluginをインストールするだけで目次が追加される

This plugin will add table of content (toc) to the page automatically. When you build the book, it will insert a table of content automatically

明示的に<!-- toc -->を追加すればその箇所をreplaceする形で目次が挿入されるようである

or to place where you insert \<!-- toc -->

また、目次が不要な場合は<!-- notoc -->を明示的に入れなければならないようである

Sometimes you may want to disable toc on some page, just add \<!-- notoc --> on the the markdown page.

このpluginの導入に伴い、READMEの見出しの文言を修正
これは、markdownのページ内リンクが同一文言の見出しについては先頭にあるものだけ有効となる挙動のため、目次を有効かするために修正したものである

amenoci commented 5 years ago

内容確認

手元でドキュメントサーバの起動によるドキュメント参照も確認

マージする