HonKit は GitBook（legacy） を Fork して作られたドキュメントページ・書籍作成ツールです。
作者の azu さんのブログ『Web Scratch』に開発の経緯などが詳しく書かれています。
作ったデモページ
Firebase で公開しています。
勉強のために「架空のサポートサイト」というテーマで何か作ってみようと思い立ったものですが、せっかくなので HonKit を使う手順をまとめてみました。セットアップからちょっとしたカスタマイズまで、手元の操作をそこそこ詳しく落とし込めたかなと思っています。
なぜ HonKit を使おうと思ったのか
手順はデモページに全て書いてしまったので、このブログエントリではデモページには掲載していない部分について触れておこうと思います。
私の仕事はフロントエンドエンジニアで、いくつかのシステム開発に関わっています。製品のリリースと並行して社外・社内向けのドキュメントサイトを用意することがあり、そんな時に必ず出てくるのがツール選定の悩みです。今まで使ったツールは WordPress や GitHub Pages があり、静的コンテンツを生成する手法としては Jekyll や Hugo などを使ったことがあります。これらのツールはそれぞれアップデートもされていて使い勝手も悪くないのですが、どうしても普段のシステム開発とは違ったコマンド群や記法を学習することになります。
専属のメンテナーがいればそれほど問題にはならないかもしれませんが、小規模の開発体制の現場ではシステム開発しているエンジニアが自分自身で記事を書いたりメンテナンスをしています。セットアップやビルドでなじみのない独特のエラーにぶちあたった時、それを乗り越えて使いこなすだけのナレッジが全てのメンバーに均等に行き渡らず、そのツールを導入した最初のメンバーが職人と化してセットアップ作業やメンテナンスを一手に引き受ける傾向がありました。
どの領域のエンジニアでもセットアップできて、かんたんに記事が書けて、変更履歴がログに残って、ガチガチのテンプレ縛りがなく見た目もそこそこカスタマイズできる、そんなツールはないのか....！？あった、gitbook-cli！しかし動かぬ！！
..........legacyだと？？？？
すみません最後のほう熱くなりましたが、そんな感じで涙目でググッていたら見つけたのが HonKit というわけです。
使ってみてどうだったか
どの領域のエンジニアでもセットアップできて、かんたんに記事が書けて、変更履歴がログに残って、ガチガチのテンプレ縛りがなく見た目もそこそこカスタマイズできる
この部分に関しては私の求めていたニーズにジャストフィットしていると言えます。試しにデプロイしたのは FireBase ですが、ビルドして静的コンテンツを吐き出すという仕組みから、どのホスティングサービスでもいけると思います。
何より legacy になった gitbook-cli を生まれ変わらせてみんなが使えるようにメンテナンスしてくれていることが嬉しいですね。セットアップからデプロイまで身近な git の操作で完結できることが有り難く、エンジニアの受け入れ度が高いことが予想されます。
興味をもってくれた方は、ぜひデモページをご覧いただければと思います。