Skip to content
🍃 A Docker image containing the GBIF Asciidoctor toolchain
CSS Ruby Shell HTML Dockerfile Makefile
Branch: master
Clone or download
This branch is 49 commits ahead, 70 commits behind asciidoctor:master.

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
asciidoctor-extensions-lab @ 7d9023c
gbif-extensions/lib
gbif-stylesheet
gbif-templates
gbif-theme
tests
.dockerignore
.gitattributes
.gitignore
.gitmodules
.travis.yml
Dockerfile
GbifHtmlConverter.rb
Makefile
README.adoc
build
github-mark.svg
inline-syntax-highlighting.patch

README.adoc

GBIF Asciidoctor Toolkit

The toolkit

This is a Docker container derived from docker-asciidoctor, but with the addition of:

  • GBIF templates and styling

  • GBIF document build script

The Asciidoctor Docker container provides:

  • Asciidoctor

  • Asciidoctor Diagram with Graphviz integration (supports plantuml and graphiz diagrams)

  • Asciidoctor PDF

  • Asciidoctor EPUB3

  • Asciidoctor Mathematical

  • AsciiMath

  • Source highlighting using CodeRay or Rouge

  • Asciidoctor Confluence

How to use it

From the top-level directory containing the GBIF document, run:

docker run --rm -it --user $(id -u):$(id -g) -v $PWD:/documents/ gbif/asciidoctor-toolkit

Your documents will be processed, and output in the same directory.

Component details

There are multiple ways to change Asciidoctor templates, two are used here. This can help me decide whether I should only use one method.

gbif-templates

These templates are copied from https://github.com/asciidoctor/asciidoctor-backends, which are examples (no longer maintained).

Only the templates that need to be overridden are copied, with some changes to bring them up-to-date with the HTML converter.

GbifHtmlConverter.rb

This overrides just particular methods of the Ruby converter.

You can’t perform that action at this time.