abradshaw/docker-asciidoctor

Asciidoctor Docker容器

镜像概述

本Docker镜像提供了完整的Asciidoctor环境，支持将AsciiDoc文档转换为HTML、PDF、EPUB3等多种格式，并集成了图表生成、代码高亮等辅助功能。

核心功能

• 包含Asciidoctor 1.5.4版本
• 支持Asciidoctor Diagram（集成Graphviz，可生成PlantUML和Graphviz图表）
• 提供Asciidoctor PDF（alpha版）和EPUB3（alpha版）导出能力
• 支持CodeRay或Pygments代码高亮
• 集成Asciidoctor backends、fopub、confluence插件及Lazybones（用于Asciidoctor-revealjs）

使用场景

• 技术文档编写与多格式转换（如生成HTML手册、PDF报告）
• 生成包含架构图/流程图的文档
• 导出EPUB3格式电子书
• 向Confluence平台发布文档

配置说明

部署示例

Docker Run命令

bash
docker run -it -v /本地文档目录:/documents/ docker.xuanyuan.run/abradshaw/docker-asciidoctor

将本地目录挂载到容器内/documents/目录，实现文件共享。

常用操作命令

• 基础格式转换：

  bash
  asciidoctor sample.adoc  # 转HTML
  asciidoctor-pdf sample.adoc  # 转PDF
  asciidoctor-epub3 sample.adoc  # 转EPUB3
  

• 带图表的文档转换：

  bash
  asciidoctor -r asciidoctor-diagram sample-with-diagram.adoc
  asciidoctor-pdf -r asciidoctor-diagram sample-with-diagram.adoc
  

• 使用backends模板：

  bash
  asciidoctor -T /asciidoctor-backends/slim/dzslides myFile.adoc
  

• fopub转换：

  bash
  asciidoctor -b docbook sample.adoc
  fopub sample.xml
  

• Confluence发布：

  bash
  asciidoctor-confluence --host HOSTNAME --spaceKey SPACEKEY --title TITLE --username USER --password PASSWORD sample.adoc