rdmueller/doctoolchain

docToolchain Docker镜像文档

镜像概述与主要用途

该镜像为docToolchain的Docker容器化实现，旨在提供无需本地安装即可运行docToolchain的便捷方式。通过容器化部署，可有效避免环境依赖问题，快速在各类项目中执行文档生成、格式转换等任务，简化文档处理流程。

核心功能与特性

• 容器化运行：无需在本地安装docToolchain及其依赖组件，直接通过Docker容器执行文档处理命令
• 项目集成：支持通过脚本快速集成到项目中，标准化文档处理流程
• 参数可配置：允许覆盖docToolchain版本及配置文件路径等关键参数
• 跨平台支持：提供Linux/macOS和Windows平台的专用脚本示例

使用场景

• 项目文档自动化生成（如HTML、PDF等格式）
• 持续集成/持续部署(CI/CD)流程中的文档构建环节
• 跨团队协作时确保文档工具环境一致性
• 临时或测试环境中的文档处理需求

使用方法

Linux/macOS系统

1. 在项目根目录创建bash脚本（建议命名为doctoolchain.sh）：

bash
#!/usr/bin/env bash
docker run --rm -it --entrypoint /bin/bash -v ${PWD}:/project rdmueller/doctoolchain:rc-2.0.0-rc14 \
-c "doctoolchain . $1 $2 $3 $4 $5 $6 $7 $8 $9 -PinputPath=src/main/asciidoc -PmainConfigFile=config/docToolchain.groovy && exit"

2. 赋予脚本执行权限：

bash
chmod +x doctoolchain.sh

3. 执行docToolchain命令，例如生成HTML文档：

bash
./doctoolchain.sh generateHTML

Windows系统

1. 在项目根目录创建批处理脚本（建议命名为doctoolchain.bat）：

docker run --rm --entrypoint /bin/bash -it -v %cd%:/project rdmueller/doctoolchain:rc-1.2.0 -c "doctoolchain . %1 %2 %3 %4 %5 %6 %7 %8 %9 -PinputPath=src/main/asciidoc -PmainConfigFile=config/docToolchain.groovy && exit"

2. 直接运行脚本执行命令，例如生成HTML文档：

doctoolchain.bat generateHTML

配置参数说明

• 镜像版本：通过修改镜像标签（如:rc-2.0.0-rc14）指定使用的docToolchain版本
• 输入路径：通过-PinputPath参数设置Asciidoc源文件路径，默认值为src/main/asciidoc
• 配置文件：通过-PmainConfigFile参数指定配置文件路径，默认值为config/docToolchain.groovy

开发与部署

• 镜像构建触发条件：当GitHub仓库（https://github.com/docToolchain/docker-image%EF%BC%89%E5%8F%91%E7%94%9F%E5%8F%98%E6%9B%B4%E6%88%96%E5%88%9B%E5%BB%BA%E6%96%B0%E6%A0%87%E7%AD%BE%E6%97%B6%EF%BC%8C%E5%B0%86%E8%87%AA%E5%8A%A8%E8%A7%A6%E5%8F%91%E6%96%B0%E9%95%9C%E5%83%8F%E6%9E%84%E5%BB%BA
• 镜像获取地址：构建完成的Docker镜像可通过Docker Hub（https://hub.docker.com/r/rdmueller/doctoolchain/builds%EF%BC%89%E8%8E%B7%E5%8F%96