https://github.com/barthel/docker-asciidoctor

Asciidoctor and additional diagram-/tools multi platform Docker image.
https://github.com/barthel/docker-asciidoctor

aarch64 amd64 arm64 asciidoctor asciidoctor-diagram docker docker-image multiplatform

Last synced: 3 months ago
JSON representation

Asciidoctor and additional diagram-/tools multi platform Docker image.

Host: GitHub
URL: https://github.com/barthel/docker-asciidoctor
Owner: barthel
Created: 2023-03-20T17:48:34.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2026-03-24T06:28:33.000Z (3 months ago)
Last Synced: 2026-03-25T08:04:27.266Z (3 months ago)
Topics: aarch64, amd64, arm64, asciidoctor, asciidoctor-diagram, docker, docker-image, multiplatform
Language: Dockerfile
Homepage: https://hub.docker.com/r/uwebarthel/asciidoctor
Size: 23.6 MB
Stars: 9
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

          # Asciidoctor — multi platform Edition

The goal of this project is to build a multi-platform (arm64, amd64) Docker image based on the original [Asciidoctor Docker image](https://github.com/asciidoctor/docker-asciidoctor) and adding all extra diagram tools supported by [Asciidoctor Diagram](https://docs.asciidoctor.org/diagram-extension/latest/).

An overview of all supported diagram types, generated as HTML and as PDF, can be found here: 

## ⚠️ Note

The original [Asciidoctor Docker image](https://github.com/asciidoctor/docker-asciidoctor) is delivered from version [*1.63.0*](https://github.com/asciidoctor/docker-asciidoctor/releases/tag/1.63.0) as a multi platform container with `amd64` and `arm64`.

Unfortunately, it is not possible to provide **`armv7`** version greater than [1.46](https://github.com/barthel/docker-asciidoctor/releases/tag/1.46.0) anymore because updated Java-based tools no longer use Java 8 and there is no Java runtime environment greater than version 8 on Alpine Linux **`armv7`**.

## Additional diagram tools

The following additional diagram tools are installed:

* [asciidoctor-diagram-jsyntrax](https://github.com/atp-mipt/jsyntrax)

* [ASCIIToSVG](https://github.com/asciitosvg/asciitosvg)^[1]

* [barby](https://github.com/toretore/barby)^[1]

* [blockdiag/blockdiag](https://github.com/blockdiag/blockdiag)^[1]

* [blockdiag/actdiag](https://github.com/blockdiag/actdiag)^[1]

* [blockdiag/nwdiag](https://github.com/blockdiag/nwdiag)^[1]

* [blockdiag/seqdiag](https://github.com/blockdiag/seqdiag)^[1]

* [bpmn-js-cmd](https://github.com/gtudan/bpmn-js-cmd)

* [bytefield-svg](https://github.com/Deep-Symmetry/bytefield-svg)

* [diagrams](https://diagrams.mingrammer.com/)

* [ditaa](https://ditaa.sourceforge.net/)^[1]

* [dpic](https://gitlab.com/aplevich/dpic)

* [erd-go](https://github.com/kaishuu0123/erd-go/)

* [gnuplot](http://gnuplot.info/)^[1]

* [graphviz](https://graphviz.gitlab.io/)^[1]

* [imagemagick](https://asciidoctor.org/docs/asciidoctor-diagram/#meme) for meme

* [mermaid](https://github.com/mermaid-js/mermaid-cli)

* [nomnoml](https://github.com/skanaar/nomnoml)

* [pikchr](https://pikchr.org)

* [plantuml](https://plantuml.com/)^[1]

* [state-machine-cat (smcat)](https://github.com/sverweij/state-machine-cat/)

* [svgbob](https://github.com/ivanceras/svgbob)

* [symbolator](https://github.com/hdl/symbolator) uses fork, because of incompatible python setup (2to3)

* [tikz](https://github.com/pgf-tikz/pgf)^[1]

* [umlet](https://www.umlet.com)

* [vega](https://vega.github.io/vega) and [vega-lite](https://vega.github.io/vega-lite)

* [wavedrom](https://wavedrom.com/)

Additional non-diagram tools:

* [graphicsmagick](http://www.graphicsmagick.org/)

  > GraphicsMagick is the swiss army knife of image processing.

* [htmlark](https://github.com/BitLooter/htmlark)  

  > Embed images, CSS, and JavaScript into an HTML file. Through the magic of data URIs, HTMLArk can save these external dependencies inline right in the HTML. \

  > —David Powell, 

* [inliner](https://github.com/barthel/inliner) fork of 

  > Turns your web page to a single HTML file with everything inlined - perfect for appcache manifests on mobile devices that you want to reduce those http requests. \

  > —Remy Sharp, 

* [asciidoctor-extensions](https://github.com/asciidoctor/asciidoctor-extensions-lab) available in `/usr/local/asciidoctor-extensions` and could be used like: `asciidoctor -r /usr/local/asciidoctor-extensions/lib/glob-include-processor.rb ...` \

  ⚠ Please do not use this code in production. The code is untested.

* [asciidoctor-multipage](https://github.com/owenh000/asciidoctor-multipage)

  > It extends the stock HTML converter to generate multiple HTML pages from a single, large source document.

* [asciidoctor-lists](https://github.com/Alwinator/asciidoctor-lists)

  > An asciidoctor extension that adds a list of figures, a list of tables, or a list of anything you want.

## ⚠️ Note

The following diagram tools are not installed because there is no executable file for all supported platforms:

* [erd](https://github.com/BurntSushi/erd) was replaced by [erd-go](https://github.com/kaishuu0123/erd-go/)

* [mscgen](http://www.mcternan.me.uk/mscgen/) (has been replaced by [mscgen_js](https://github.com/mscgenjs/mscgenjs-cli), but is currently not maintained)

* [shaape](https://github.com/christiangoltz/shaape)

* [syntrax](https://kevinpt.github.io/syntrax) was replaced by [asciidoctor-diagram-jsyntrax](https://github.com/atp-mipt/jsyntrax)

## Usage

Use `info` or `container_info` to retrieve information about the container itself, such as its name, version, and information about the Asciidoctor base container.

```bash

docker run --rm \

  docker.io/uwebarthel/asciidoctor:latest \

  info

```

Use `version` to retrieve the installed Asciidoctor version and the version information of the installed Asciidoctor tools.

```bash

docker run --rm \

  docker.io/uwebarthel/asciidoctor:latest \

  version

```

Generate HTML document:

```bash

docker run --rm \

  -v $(pwd)/src/doc:/documents/ \

  -v $(pwd)/dist:/dist \

  docker.io/uwebarthel/asciidoctor:latest \

    asciidoctor \

      -b html5 \

      -D "/dist" \

      -r asciidoctor-diagram \

      -r asciidoctor-mathematical \

      -r /usr/local/asciidoctor-extensions/lib/glob-include-processor.rb \

      /documents/asciidoctor-diagram_overview.adoc

```

Generate inlined HTML document via `inliner` based on generated HTML document:

```bash

docker run --rm -it \

  -v $(pwd)/dist:/dist \

  docker.io/uwebarthel/asciidoctor:latest \

    inliner \

      --nocompress \

      --preserve-comments \

      --inlinemin \

      --videos \

      /dist/asciidoctor-diagrams_overview.html 2>/dev/null 1> dist/asciidoctor-diagrams_overview_inlined.html

```

Generate PDF document:

```bash

docker run --rm \

  -v $(pwd)/src/doc:/documents/ \

  -v $(pwd)/dist:/dist \

  docker.io/uwebarthel/asciidoctor:latest \

    asciidoctor-pdf \

      -D "/dist" \

      -r asciidoctor-diagram \

      -r asciidoctor-mathematical \

      -r /usr/local/asciidoctor-extensions/lib/glob-include-processor.rb \

      /documents/asciidoctor-diagram_overview.adoc

```

Docker Hub: https://hub.docker.com/r/uwebarthel/asciidoctor

## Building

```bash

docker build \

  --build-arg CONTAINER_INFORMATION="docker.io/uwebarthel/asciidoctor:latest ($(git rev-parse --short HEAD))" \

  --tag uwebarthel/asciidoctor:latest \

  --tag docker.io/uwebarthel/asciidoctor:latest \

  .

```

---

^[1] provided by original Asciidoctor Docker Image

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/barthel/docker-asciidoctor

Awesome Lists containing this project

README