curs/asciidoctor-od

Asciidoctor Open Document 转换镜像

镜像概述

本Docker镜像基于Asciidoctor工具链，专注于将Asciidoc格式文件转换为开放文档格式（如ODT）。通过容器化方式提供独立运行环境，避免本地依赖配置，简化文档格式转换流程，适用于需要快速、标准化处理Asciidoc文档的场景。

核心功能与特性

• 格式转换：支持将Asciidoc(.adoc)文件转换为Open Document Text(.odt)格式
• 零依赖部署：容器化设计，无需在本地安装Asciidoctor及相关插件
• 标准化流程：提供一致的转换环境，确保跨平台转换结果一致性
• 轻量级设计：基于精简基础镜像，减少资源占用

使用场景

• 技术文档作者将Asciidoc格式文档转换为ODT格式以便于协作编辑
• CI/CD流程中集成文档转换步骤，实现自动化文档生成
• 在无本地Asciidoctor环境的系统中快速处理Asciidoc文件
• 需要统一文档转换标准的团队或项目

使用方法

基本转换命令

通过挂载本地目录并执行转换命令：

bash
docker run --rm -v $(pwd):/documents docker.xuanyuan.run/courseorchestra/asciidoctor-open-document \
  asciidoctor -r asciidoctor-open-document -b odt input.adoc -o output.odt

参数说明：

• -v $(pwd):/documents：将当前目录挂载到容器内的/documents目录
• --rm：容器运行结束后自动删除
• asciidoctor：Asciidoctor主命令
• -r asciidoctor-open-document：加载Open Document转换插件
• -b odt：指定输出格式为ODT
• input.adoc：输入的Asciidoc文件路径（相对于挂载目录）
• -o output.odt：指定输出文件路径（相对于挂载目录）

批量转换示例

转换当前目录下所有.adoc文件：

bash
docker run --rm -v $(pwd):/documents docker.xuanyuan.run/courseorchestra/asciidoctor-open-document \
  sh -c "for file in *.adoc; do asciidoctor -r asciidoctor-open-document -b odt \$file -o \${file%.adoc}.odt; done"

配置说明

可通过Asciidoctor命令行参数调整转换行为，常用参数包括：

• -a toc：生成目录
• -a numbered：对章节进行编号
• -a icons=font：使用字体图标
• --attribute=stylesheet=custom.css：应用自定义样式表

详细参数可参考https://docs.asciidoctor.org/

更多信息

项目源代码及详细文档：https://github.com/CourseOrchestra/asciidoctor-open-document