Asciidoctor Docker Container

The environment

This Docker container provides:

Asciidoctor 2.0.10
Asciidoctor Diagram 1.5.18 with Graphviz integration (supports plantuml and graphiz diagrams)
Asciidoctor PDF 1.5.0.alpha.18
Asciidoctor EPUB3 (alpha)
Asciidoctor Mathematical
AsciiMath
Source highlighting using CodeRay or Pygments
Asciidoctor Confluence

How to use it

Just run:

docker run -it -v <your directory>:/documents/ asciidoctor/docker-asciidoctor

It will be directly mapped with /documents of the container.

Once started, you can use Asciidoctor commands to convert AsciiDoc files you created in the directory mentioned above. You can find several examples below.

To run Asciidoctor on a basic AsciiDoc file:

asciidoctor sample.adoc
asciidoctor-pdf sample.adoc
asciidoctor-epub3 sample.adoc

To run AsciiDoc on an AsciiDoc file that contains diagrams:

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

To use Asciidoctor Confluence:

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

Batch mode. You can use it in a "batch" mode

docker run --rm -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf index.adoc

How to contribute / do it yourself ?

Requirements

You need the following tools:

A bash compliant command line
GNU make
bats installed and in your bash PATH
Docker installed and in your path

How to build and test ?

"bats" is used as a test suite runner. Since the ability to build is one way of testing, it is included.
You just have to run the bats test suite, from the repository root:
```
make test
```

Include test in your build pipeline or test manually

You can use bats directly to test the image, optional you can use a custome image name:

# If you want to use a custom name for the image, OPTIONAL
export DOCKER_IMAGE_NAME_TO_TEST=your-image-name
bats tests/*.bats