🔖

GitBook がしれっと HonKit になってた件

2021/12/25に公開約2,300字

HonKit

公式ドキュメント

HonKit 製作者によると GitBook -> HonKit への移行の経緯は以下の通りです。

GitBookはMarkdownからドキュメントページや書籍を作成するツールですが、 以前OSSで公開されていたGitBook(legacy)はDeprecatedとなって開発は止まっています。

⚠️ Deprecation warning:

As the efforts of the GitBook team are focused on the GitBook.com platform, the CLI is no longer under active development. All content supported by the CLI are mostly supported by our GitBook.com / GitHub integration. Content hosted on the legacy.gitbook.com will continue working until further notice. For differences with the new vesion, check out our documentation.

代わりにOSSではない https://www.gitbook.com/ の方に移行する形になっています。 つまり、新しいGitBookはGitBook.com上でのホスティングサービスとなっています。

(中略)

これを解決するため、GitBook(legacy)をForkしてHonKitを作りました。

引用元:GitBookをForkしてHonKitを作りました - Web Scratch

GitBook の OSS の開発が止まってしまったので、それの後続として HonKit を fork して開発が続けられていたみたいです。

また、使用ライセンスは GitBook と同じく Apache License 2.0 になります。

GitBook is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

引用元:HonKit

一応、Apache License 2.0 のライセンスは勝手に再配布などをしなければ商用利用しても良いものになります。

【参考】
商用利用できるオープンソースライセンスはけっきょくどれで何をすればいいのか?
Apache License 2.0とは?ライセンス内容をやさしく解説

GitBook と HonKit の違い

GitBook と HonKit の違いについては Honkit 製作者の記事が1番わかりやすかったです。

変更点は book.json で行っていたプラグインの管理を、package.json と npm でのパッケージ(プラグイン)管理に寄せただけで、あとは既存のままで動くとのことでした。

具体的には book.json の plugins に入れていたプラグインを honkit-plugin-* または gitbook-plugin-** はプラグイン名に置き換える)という名前で npm install <package> して、gitbook install の代わりに npm install してくださいとのことです。

その他、build や serve などのコマンドが gitbook xxx から honkit xxx に変更されました。

詳しくは公式ドキュメントを参考にしてください。

試しに GitBook を使っていた環境を HonKit に移行してみたのですが、上記のように、package.json を作成して、必要なプラグインを npm install した後に honkit build または honkit serve すれば動きました。

使用感は GitBook と変わりませんでした。

GitHubで編集を提案

Discussion

ログインするとコメントできます