clickhouse/docs-builder

ClickHouse 文档构建工具镜像

概述

ClickHouse 文档构建工具镜像是一个预配置的 Docker 镜像，集成了构建 ClickHouse 官方文档所需的全部依赖和工具链。该镜像旨在简化 ClickHouse 文档的本地构建与预览流程，确保文档生成环境的一致性，同时支持集成到 CI/CD pipeline 中实现文档的自动化构建与发布。

特性

• 自动化构建流程：内置文档构建脚本，支持一键触发从源码到输出的完整流程
• 多格式输出：支持生成 HTML、PDF 等多种文档格式，满足不同场景需求
• 版本同步：与 ClickHouse 源码版本保持同步，确保文档与对应版本功能匹配
• 轻量级设计：基于 Alpine 基础镜像，优化工具链依赖，减少镜像体积

使用场景

• 开发人员本地修改文档后，快速构建并预览效果
• CI/CD 流程中集成，在文档提交或源码更新时自动生成最新文档
• 文档维护团队批量生成多版本、多格式的官方文档

部署示例

本地构建文档

bash
# 拉取镜像
docker pull clickhouse/docs-builder:latest

# 运行容器，挂载本地文档源码目录并构建 HTML 文档
docker run --rm -v $(pwd)/clickhouse-docs:/docs clickhouse/docs-builder:latest build --format html --output /docs/_build/html

CI/CD 集成（示例：GitHub Actions）

yaml
jobs:
  build-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Pull docs builder image
        run: docker pull clickhouse/docs-builder:latest
      - name: Build docs
        run: docker run --rm -v $(pwd)/docs:/docs clickhouse/docs-builder:latest build --format html
      - name: Upload artifact
        uses: actions/upload-artifact@v3
        with:
          name: docs-html
          path: docs/_build/html

注意事项

• 挂载目录需包含 ClickHouse 文档源码（通常位于 ClickHouse 源码仓库的 docs 目录）
• 支持通过 --help 参数查看构建命令的更多配置选项（如指定输出路径、语言版本等）