dockerイメージの使い方
docker-compose.yml
web:
image: tukiyo3/honkit
restart: always
volumes:
- ./honkit:/srv/honkit
ports:
- "4000:4000"
起動
docker-compose up
chmod -R 777 ./honkit/
# プラグインの設定
cp book.json ./honkit/
vim ./honkit/README.md
Gitbookのプラグイン追加方法
- 日本語検索対応の
search-pro-fixed
を利用するには
npm i gitbook-plugin-search-pro-fixed
※ gitbook install
ではないので注意!
./honkit/book.json
{
"plugins": [ "-lunr", "-search", "search-pro-fixed" ]
}
※ search-pro-kui
ではうまく検索できなかった。
GitHub Pages に UPするときのハマりポイント
-
_book
のような、アンダースコアから始まるフォルダは404
を返される。-
.nojekyll
という空ファイルを置けば解決。
-
HonKitについて
- mdbook より良い点
- デザインが洗練されている。
- IE11で動く。
- GitBookをForkしてHonKitを作りました | Web Scratch
- Gitbook の更新が止まって
npm 6
までしか対応してなかったのをフォークしてして最新のnpm 14
に対応。 - https://github.com/honkit/honkit
- 開発が活発 honkit/CHANGELOG.md 2020/7/28時点での最新は
3.5.2
(参考までに) 公式のdockerイメージの使い方
honkit init
docker-compose.yml
honkit:
image: honkit/honkit
restart: always
volumes:
- ./honkit:/srv/honkit
ports:
- 4000:4000
working_dir: /srv/honkit
# init
docker-compose run honkit honkit init
honkit serve
# serve
docker-compose run honkit honkit serve
もしくは以下
docker-compose.yml
honkit:
image: honkit/honkit
restart: always
volumes:
- ./honkit:/srv/honkit
ports:
- 4000:4000
working_dir: /srv/honkit
command: honkit serve
docker-compose up