Honkitのプラグインの探し方と使い方
公式ドキュメントを読んで探し方を探す
HonKitのドキュメントのプラグインの項を読むと plugins.gitbook.com で探せと書いてあるったがそのページはすでにNot Found。
代わりにnpmjs.comに行って「gitbook-plugin」「honkit-pluguin」で検索すればよかった。
JavaScript力低いからちょっと悩んでしまった。
ちなみにnpmjs.comで「gitbook-plugin」を検索すると1406個。めちゃめちゃ多い。
特定のプラグインを探してるわけではなかったが、試しにTOCツリーつけてみようかなと思って「gitbook-plugin toc」で検索したら31個も出てきた。
これは頼もしいけど、反面使いやすいの探し出すまで大変そうやね。
プラグインの使い方
package.jsonに書いてnpm installしてbook.jsonで読み込みの設定をする。
例えばsearch-pro-kuiを使うには以下のようにする。
package.json
{
"dependencies": {
"honkit": "3.6.x",
"gitbook-plugin-search-pro-kui": "1.0.x"
}
}
honkitは毎回npxで起動するの時間かかるなということで入れたもの。
book.json
{
"plugins": [
"-lunr", "-search", "search-pro-kui"
]
}
デフォルトで入っているlunrとsearchを外すのにマイナスをつけてる。
デフォルトで有効なプラグイン
honkit serveしたときのメッセージを読むと、以下のプラグインがデフォルトで読みこまれているらしい
info: plugin "livereload is loaded
info: plugin "highlight is loaded
info: plugin "search is loaded
info: plugin "lunr is loaded
info: plugin "fontsettings is loaded
info: plugin "theme-default is loaded
テーマの使い方
テーマもプラグインになってるので、プラグインとして読み込めば使える。
「gitbook-plugin theme」で検索したら200個出てきた。
デフォルトのテーマ十分きれいだしデフォルトでいいかという気分になりますね。
追記
ドキュメント修正のプルリク出したらマージされたぜ!
これでコントリビューターを名乗れるとはコスパいい(別に名乗らない)