基本的なこと
- HonKitの設定はbook.jsonで行います。
- Font Awesomeはv4までです。
- Gitbookのプラグインも使えます。
- テーマやプラグインは割と簡単につくれます。
- ビルドするとmdファイルがhtmlになります。
- CSSやJavaScriptも使えます。
- 全ての答えは公式サイトにある!(((はず
四の五の言わずさっそく作ってみましょう。
任意のフォルダで右クリックからVSCodeを開いてください。
VSCodeのターミナルを開いたら下記を順番に実行してください。
mkdir project && cd project && mkdir source
npm init --y
npm install honkit --save-dev
npx honkit init ./source
特に説明は不要かと思いますが、ポイントとしてはprojectフォルダに設定を置いたり成果物が入り、sourceフォルダに作りたいサイトの中身をぶち込んでいきます。
initによって作成されたREADMEはトップページにあたりSUMMRYが画面左にある目次にあたります。
book.json
type nul > book.json
book.jsonファイルを作成したら別ページにサンプルを置いてあるのでbook.jsonにコピペしてください。重要なのは root、plugins、pluginsConfigの3つだけです。
npmでインストールしたプラグインはpackage.jsonに登録され、その中からhonkitで使いたいプラグインをbook.jsonで指定および有効化します。そして指定したプラグイン自体の設定をpluginsConfigによって行います。
package.json
これも別ページにサンプルを置いてあるのでpackage.jsonにコピペしてください。
先ほどnpmでインストールしたプラグインはpackage.jsonに登録されると言いましたが、逆に予めpackage.jsonに登録しておいてまとめてインストールすることもできます。下記を実行してみてください。
npm install --save-dev
⚠️HonKitをグローバルに入れたならプラグインもグローバルに、HonKitをローカルに入れたならプラグインもローカルに入れないとダメらしいです!推奨はローカルとのこと。
voltaやenvなどを入れているなら本来は気にせず --save-dev
や npx
を使わなくても大丈夫です。ただ、このサイトでは統一して --save-dev
や npx
を使います。
SUMMARY.md
まだ空の状態だと思いますので、試したい場合は下記をSUMMARY.mdに予めコピペしてください。
* [Part I](part1/README.md)
* [Writing is nice](part1/writing.md)
* [HonKit is nice](part1/honkit.md)
* [Part II](part2/README.md)
* [We love feedback](part2/feedback_please.md)
* [Better tools for authors](part2/better_tools.md)
フォルダやファイルがまだない状態で先ほどのnpx honkit init ./source
を実行すると自動的に生成してくれます。
ローカルでの確認とビルド
ローカルサーバーの起動
npx honkit serve
アクセスしたら見れる http://localhost:4000
ビルド
npx honkit build
どちらも_book
が生成されるようになっています。
docsに出力したい場合は「なにをなにに」の順番なので、下記を実行すればProject内にdocsが生成されます。
npx honkit build . docs
ちなみに、VSCodeだと右上のボタンや Ctrl+K を押して V を押したりすると横にプレビューを出せます。