Sign inSign up

bloodstar/gitbook-builder

By bloodstar

Updated about 1 month ago

A Docker Image for building ebook with Gitbook and with Noto CJK Fonts.

Image
7

10K+

bloodstar/gitbook-builder repository overview

Docker Pulls Build Status

bloodstar/gitbook-builder

Docker 镜像,用于构建 GitBook / Honkit 电子书。内置 Calibre、PlantUML、CJK 字体支持。

源码仓库:github.com/appotry/docker-gitbook


🚀 Quick Start

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

推荐使用别名:

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'

⚙️ Environment Variables

VariableDefaultDescription
NPM_CONFIG_REGISTRY(npm official)npm registry mirror. Set to https://registry.npmmirror.com for Chinese users
docker run --rm -v "$PWD":/gitbook \
  -e NPM_CONFIG_REGISTRY=https://registry.npmmirror.com \
  bloodstar/gitbook-builder npm install

✨ Features

  • GitBook CLI — Classic version, patched for Node.js 20
  • Honkit — Community-maintained fork, drop-in replacement
  • PlantUML — Diagram rendering via OpenJDK 17 + Graphviz
  • PDF / EPUB — Ebook conversion via Calibre
  • CJK Fonts — Noto Sans CJK for Chinese, Japanese, Korean
  • Multi-arch — linux/amd64, linux/arm/v7, linux/arm64
  • cnpm — Pre-installed for Chinese mirror users

🏷️ Tags

TagDescription
latestMost recent build
honkit-<version>Honkit version (e.g. honkit-6.2.1)
honkit-<major>.<minor>Honkit major.minor (e.g. honkit-6.2)
honkit-<major>Honkit major only (e.g. honkit-6)
gitbook-<version>GitBook CLI version (e.g. gitbook-2.3.2)
v<semver>Release tag on git tag push (e.g. v0.2.0)

📚 Documentation

DocumentLink
Usage Guidedocs/GUIDE.md
Architecturedocs/ARCHITECTURE.md
Requirementsdocs/REQUIREMENTS.md
Testingdocs/TESTING.md
Changelogdocs/CHANGELOG.md
中文README.md
EnglishREADME.en.md
日本語README.ja.md
한국어README.ko.md
EspañolREADME.es.md
हिन्दीREADME.hi.md
العربيةREADME.ar.md
PortuguêsREADME.pt.md
বাংলাREADME.bn.md
РусскийREADME.ru.md
FrançaisREADME.fr.md
DeutschREADME.de.md

🔗 Resources

Tag summary

Content type

Image

Digest

sha256:7e2a4f928

Size

1.1 GB

Last updated

about 1 month ago

docker pull bloodstar/gitbook-builder