freke/docker_asciidoctor

docker_asciidoctor

镜像概述和主要用途

docker_asciidoctor是一个基于alpine:edge构建的Docker镜像，包含asciidoctor工具。该镜像以asciidoctor/docker-asciidoctor为基础镜像，主要改进在于增强了日语字符支持，并支持使用plantuml生成图表，适用于需要处理日语内容的AsciiDoc文档转换场景。

核心功能和特性

• 轻量级基础：基于alpine:edge构建，保持较小的镜像体积和高效的运行性能
• 完整工具链：内置asciidoctor，支持AsciiDoc文档的解析、转换和渲染
• 日语支持增强：优化了日语字符的显示和处理能力，解决日语文本在文档生成中的乱码问题
• 图表生成：支持通过plantuml生成各类图表，并确保图表中日语文本的正确显示

使用场景和适用范围

• 技术文档写作：处理包含日语内容的AsciiDoc格式技术文档、用户手册或API文档
• 报告生成：生成包含日语文本和图表的业务报告、学术论文等
• 开发工作流：集成到CI/CD pipeline中，自动化处理包含日语的文档转换任务
• 本地化需求：满足日语环境下AsciiDoc文档的编辑和输出需求

使用方法和配置说明

基本使用示例

通过docker run命令运行容器，挂载本地文档目录并执行asciidoctor命令：

bash
docker run --rm -v $(pwd):/documents docker_asciidoctor asciidoctor your-document.adoc

参数说明：

• --rm：容器运行结束后自动删除
• -v $(pwd):/documents：将当前工作目录挂载到容器内的/documents目录，实现本地文件访问
• asciidoctor your-document.adoc：执行asciidoctor命令，转换指定的AsciiDoc文档

生成包含plantuml图表的文档

若文档中包含plantuml图表，需使用asciidoctor-diagram扩展：

bash
docker run --rm -v $(pwd):/documents docker_asciidoctor asciidoctor -r asciidoctor-diagram your-document-with-diagrams.adoc

自定义输出格式

支持转换为HTML、PDF等多种格式，例如生成PDF：

bash
docker run --rm -v $(pwd):/documents docker_asciidoctor asciidoctor-pdf your-document.adoc

docker-compose配置示例

创建docker-compose.yml文件，简化文档处理流程：

yaml
version: '3'
services:
  asciidoctor:
    image: docker_asciidoctor
    volumes:
      - ./docs:/documents
    command: asciidoctor -r asciidoctor-diagram /documents/source.adoc -o /documents/output.html

运行命令：

bash
docker-compose up

此配置会将当前目录下的docs文件夹挂载到容器，处理source.adoc并输出output.html到docs目录。