khs1994/gitbook

GitBook Docker

https://img.shields.io/github/stars/khs1994-docker/gitbook.svg?style=social&label=Stars](https://github.com/khs1994-docker/gitbook) https://img.shields.io/docker/stars/khs1994/gitbook.svg](https://store.docker.com/community/images/khs1994/gitbook/) https://img.shields.io/docker/pulls/khs1994/gitbook.svg](https://store.docker.com/community/images/khs1994/gitbook/)

支持的标签及对应Dockerfile链接

• https://github.com/khs1994-docker/gitbook/tree/master/alpine/Dockerfile

目的

在CI环境中构建GitBook文档时，环境安装往往耗时较长。本镜像将GitBook环境打包为容器，可大幅节省环境配置时间，提升文档构建效率。

镜像概述

1. 基于最新版Node.js和GitBook构建；
2. 预安装GitBook及其常用插件（具体可查看alpine/book.json文件）；
3. 支持基于alpine/book.json定制化构建自有镜像。

核心功能

• GitBook文档编译构建；
• 本地预览文档（通过server命令）；
• 部署文档到代码仓库（支持SSH和TOKEN两种验证方式）；
• 集成GitHub Actions实现自动化构建与部署。

使用场景

• CI/CD流程中自动化构建和部署GitBook文档；
• 本地快速预览GitBook文档效果，无需手动配置环境；
• 团队协作中统一文档构建环境，避免版本差异问题。

配置说明与使用示例

前提条件

进入GitBook源码所在文件夹。

构建文档

bash
$ docker run -it --rm \
    -v $PWD:/srv/gitbook-src \
    khs1994/gitbook

本地预览文档

bash
$ docker run -it --rm \
    -v $PWD:/srv/gitbook-src \
    -p 4000:4000 \
    khs1994/gitbook \
    server

部署文档到代码仓库

SSH验证方式

bash
$ docker run -it --rm \
    -v $PWD:/srv/gitbook-src \
    -v ~/.ssh:/root/.ssh \
    -e GIT_USERNAME=username \
    -e GIT_USEREMAIL=username@domain.com \
    -e GIT_REPO=git@github.com:username/repo \
    -e GIT_BRANCH=master \
    khs1994/gitbook \
    deploy

TOKEN验证方式

bash
$ docker run -it --rm \
    -v $PWD:/srv/gitbook-src \
    -e GIT_USERNAME=username \
    -e GIT_USEREMAIL=username@domain.com \
    -e GIT_TOKEN=mytoken \
    -e GIT_REPO=github.com/username/repo \
    -e GIT_BRANCH=master \
    khs1994/gitbook \
    deploy

集成GitHub Actions

yaml
- name: GitBook Build
  uses: docker://khs1994/gitbook
- name: GitBook Deploy
  uses: docker://khs1994/gitbook
  if: github.event_name == 'push'
  with:
    args: deploy
  env:
    GIT_USERNAME: "khs1994"
    GIT_USEREMAIL: "khs1994@khs1994.com"
    GIT_BRANCH: "gh-pages"
    GITHUB_TOKEN: ${{ secrets.PCIT_GIT_TOKEN }}
    # 若使用默认 ${{ secrets.GITHUB_TOKEN }}，推送后Pages服务不会自动构建，需使用自定义Token
    # GIT_REPO: github.com/username/repo（如需推送到其他仓库时传入）
    # 传入GIT_REPO时必须同时传入GIT_TOKEN

更多示例：https://github.com/khs1994-website/composer-docs.zh-cn/blob/master/.github/workflows/gitbook.yaml

谁在使用该镜像？

• https://github.com/pcit-ce/pcit/blob/master/pcit_examples/gitbook.yml