HonKit(旧GitHon) を Github pages で公開する

2491 ワード
githon github-pages github-pages テキストリンク

githonというライブラリが公開されていて、キーボードの右左でページが切り替わっていく感じが好きなので GitHub Pages で公開してみたのでメモ。
(今は HonKit に名前が変わったようです。 https://efcl.info/2020/06/22/githon-to-honkit/)

元は OSS で公開されていた GitBook らしい。
https://efcl.info/2020/06/19/githon/

GitHon をインストール

GitHub の README にある Quick Start どおりにやればできる。

最後にある以下のコマンドを実行すると _book というディレクトリができるので、これをデプロイすればいい。

npx githon build

.bookignore で無駄なファイルを削除

build するときにディレクトリ内にあるファイルを全部含めて build しているように見えるので、いらないファイルは .bookignore を作って、そこに書いておくといい。

デプロイ

リポジトリは適当に作ってもらうとして、あとは gh-pages でいい感じにデプロイできる。

npm install gh-pages --save-dev

package.json デプロイコマンドをに追加。デプロイディレクトリを _book に指定する。

package.json
  "scripts": {
    "deploy": "gh-pages -d _book",
  }

あとは Github の Settings ページで gh-pages branch に変更すれば 作成したページがこんな感じ で公開される。

サクッとできて、GitBook のプラグインも互換性があって使えるっぽいので、いろいろ試してみると面白そう！