Skip to content

Latest commit

 

History

History
108 lines (88 loc) · 3.91 KB

File metadata and controls

108 lines (88 loc) · 3.91 KB

docker-gitbook-builder

🇨🇳 中文 · 🇬🇧 English · 🇯🇵 日本語 · 🇰🇷 한국어 · 🇪🇸 Español · 🇮🇳 हिन्दी · 🇸🇦 العربية
🇵🇹 Português · 🇧🇩 বাংলা · 🇷🇺 Русский · 🇫🇷 Français · 🇩🇪 Deutsch

GitBook 電子書籍を構築するための Docker イメージ。Honkit(コミュニティ保守版 GitBook)、CJK フォント、PlantUML 対応を内蔵。

Docker Image

クイックスタート

docker pull bloodstar/gitbook-builder

# 初期化
docker run --rm -v "$PWD:/gitbook" -p 4000:4000 bloodstar/gitbook-builder gitbook init
# プレビュー
docker run --rm -v "$PWD:/gitbook" -p 4000:4000 bloodstar/gitbook-builder gitbook serve
# ビルド
docker run --rm -v "$PWD:/gitbook" -p 4000:4000 bloodstar/gitbook-builder gitbook build

エイリアスを .bashrc または .zshrc に追加:

alias gitbook='docker run --rm -v "$PWD":/gitbook -p 4000:4000 bloodstar/gitbook-builder gitbook'
alias honkit='docker run --rm -v "$PWD":/gitbook -p 4000:4000 bloodstar/gitbook-builder honkit'

機能

機能 説明
GitBook CLI レガシーバージョン、Node.js 20 対応済み
Honkit コミュニティ保守版、互換性あり
PlantUML OpenJDK 17 + Graphviz による図表レンダリング
PDF/EPUB Calibre による電子書籍変換
CJK フォント Noto Sans CJK 搭載
マルチアーキ linux/amd64, linux/arm/v7, linux/arm64

使用例

# GitBook
gitbook serve    # http://localhost:4000
gitbook build
gitbook pdf .
gitbook epub .

# Honkit(推奨)
honkit serve
honkit build
honkit pdf .
honkit epub .

Docker Hub

  • イメージ: bloodstar/gitbook-builder
  • 自動タグ: latest, gitbook-<version>, honkit-<major>, honkit-<major>.<minor>, honkit-<full>
  • リリースタグ(git tag push): v<semver>(例: v0.2.0
  • タグ一覧

環境変数

変数 デフォルト 説明
NPM_CONFIG_REGISTRY (空、npm 公式を使用) npm レジストリURL。中国ユーザーは https://registry.npmmirror.com に設定
# 例:淘宝 npm ミラーを使用
docker run --rm -v "$PWD":/gitbook \
  -e NPM_CONFIG_REGISTRY=https://registry.npmmirror.com \
  bloodstar/gitbook-builder honkit install

関連ドキュメント

ドキュメント 内容
docs/GUIDE.md 詳細な使用方法、プラグイン、ミラー設定
docs/ARCHITECTURE.md コンポーネント、技術スタック、ビルドフロー
docs/TESTING.md ビルド検証とテスト方法
docs/CHANGELOG.md バージョン履歴
README.md 中文
README.en.md English
README.ko.md 한국어
README.es.md Español
README.hi.md हिन्दी
README.ar.md العربية
README.pt.md Português
README.bn.md বাংলা
README.ru.md Русский
README.fr.md Français
README.de.md Deutsch