Skip to content

README.ru.md

Latest commit

 

History

History
95 lines (75 loc) · 3.54 KB

README.ru.md

File metadata and controls

95 lines (75 loc) · 3.54 KB

docker-gitbook-builder

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

Docker-образ для создания электронных книг GitBook с Honkit (форк сообщества), шрифтами 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 Форк сообщества, совместим с book.json
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>
  • Все теги

Переменные окружения

Переменная По умолч. Описание
NPM_CONFIG_REGISTRY (офиц. npm) Зеркало npm. Китай: https://registry.npmmirror.com 
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 История версий