cafapi/doc-site-compiler

CAF项目文档网站编译镜像

镜像概述

本Docker镜像专为CAF（Cloud Adoption Framework）项目设计，提供标准化环境用于编译和构建项目文档网站。通过容器化方式封装文档编译所需依赖，简化构建流程，确保跨环境的一致性和可重复性，降低本地环境配置复杂度。

核心功能和特性

• 环境隔离：封装文档编译所需的全部依赖工具和运行环境，避免本地环境冲突
• 标准化构建：提供统一的文档编译流程，确保不同开发者和环境下构建结果一致
• 兼容性：支持主流文档格式（如Markdown）及常见静态站点生成工具
• 轻量级设计：优化镜像体积，减少资源占用，提升文档编译效率

使用场景和适用范围

• CAF项目开发团队本地文档构建与预览
• CI/CD流水线中集成文档自动构建流程
• 文档版本管理与多环境部署前的编译验证
• 需要快速搭建文档编译环境的临时场景

使用方法和配置说明

基本使用（Docker Run）

bash
docker run -v /path/to/caf-docs:/docs -v /path/to/output:/output caf-docs-builder

参数说明：

• -v /path/to/caf-docs:/docs：挂载CAF项目文档源文件目录到容器内/docs路径
• -v /path/to/output:/output：挂载输出目录到容器内/output路径，编译后的文档网站文件将输出至此

环境变量配置

自定义编译命令示例

bash
docker run -e BUILD_CMD="hugo build" -v /path/to/hugo-docs:/docs -v /path/to/hugo-output:/output caf-docs-builder

Docker Compose配置

yaml
version: '3'
services:
  docs-builder:
    image: caf-docs-builder
    volumes:
      - ./caf-docs:/docs
      - ./docs-output:/output
    environment:
      - BUILD_CMD=mkdocs build --clean

注意事项

• 确保挂载的文档源目录包含完整的项目文档结构及构建配置文件（如mkdocs.yml、hugo.toml等）
• 输出目录需具备写入权限，避免因权限问题导致构建失败
• 根据实际文档框架调整BUILD_CMD环境变量，支持mkdocs、hugo等主流静态站点生成工具