GitBook から HonKit に移行する

iEdit のユーザーズガイド

iedit.kondoumh.com

GitBook で作ってました。

blog.kondoumh.com

今年の2月に動作環境の文言を修正しようとして久々に更新した時 gitbook-cli が Deplicated になっているのに気付きました。

GitBook.com のホスティングサービス専用になって、OSS の方はメンテされなくなった模様です。

www.gitbook.com

ユーザーズガイドは GitHub Pages で公開していますが、今後 メンテされないとなると新規のドキュメントには使わない方がいいなあと思っていました。

最近 azu さんが GitBook を fork した HonKit という OSS の開発を開始されました。

github.com

自分はGitBook(legacy)の機能的にはある程度満足していたので、 主にコードベースの整理、TypeScript化、QやjQueryの依存を外すなど質的なメンテナンスが中心になる気がしています。

efcl.info

TypeScript 化や jQuery 依存の除去などは今後メンテナンスを続け、Contribute しやすくなるメリットがあると思います。

iEdit のドキュメントを HonKit でビルドしてアップデートしました。NPM 管理には移行していたので、gitbook-cli を honkit に置き換えて、script で使用するコマンドを gitbook -> honkit に変更するだけで移行完了。利用しているプラグインはそのまま動作しました。

  "devDependencies": {
-   "gitbook-cli": "^2.3.2"
+   "honkit": "^3.4.0"
  },
  "scripts": {
-   "serve": "gitbook serve",
-   "build": "gitbook build ./ ./docs"
+   "serve": "honkit serve",
+   "build": "honkit build ./ ./docs"
  },

HonKit を使えば、既存の GitBook 資産を Netlify や GitHub Pages などで安心してホスティングできるので、何より既存 GitBook ユーザには朗報ですね。