Asciidoctor Diagram

Asciidoctor Diagram is a set of Asciidoctor extensions that enable you to add diagrams, which you describe using plain text, to your AsciiDoc document.

The extensions supports the AsciiToSVG, BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag), Bytefield-SVG, Ditaa, Erd, Gnuplot, GraphViz, Mermaid, Msc, Nomnoml, PlantUML, Shaape, State Machine Cat, SvgBob, Symbolator, Syntrax, UMLet, Vega, Vega-Lite and WaveDrom syntax.

Each extension runs the diagram processor to generate an SVG, PNG, or TXT file from the input text. The generated file is then inserted into your converted document.

Asciidoctor Diagram was inspired by the AsciiDoc PlantUML filter.

Translations of the document are available in the following languages:

• 汉语

Status

Table of Contents

• Installation
• Creating a Diagram
• Generating a Diagram from a Terminal
• Advanced Usage
  • Enabling Extensions
  • Diagram Block Macro
  • Image Output Location
  • Specifying Diagram Generator Paths
  • The Meme Extension
  • Diagram Attributes

Installation

Asciidoctor Diagram is a RubyGem, which can be installed using the gem or bundle commands.

You can install the Asciidoctor Diagram gem by typing gem install in the CLI.

$ gem install asciidoctor-diagram

by first adding the following entry to your project’s Gemfile.

Gemfile

gem 'asciidoctor-diagram'

Then execute bundle in the CLI.

$ bundle

Creating a Diagram

A diagram is written inside a literal block, which can accept several attributes.

Anatomy of a diagram

[diagram-type, generated-file-name, generated-image-format] // (1) (2) (3)
.... // (4)
Diagram in appropriate syntax
....

1. The first positional attribute in the attribute list specifies the diagram that is being used.

2. The second, optional positional attribute assigns a file name (i.e. target) to the generated diagram. If a target is not specified an auto-generated name will be used.

3. The third, optional positional attribute specifies the image format to create, specified as a three character file extension.

4. Place the attribute list directly on top of the delimited literal block (....). You can also use an open block as an alternative (--).

The following diagram types and output formats are available:

Diagram Type	gif	pdf	png	svg	txt
a2s				☑️
actdiag		☑️	☑️	☑️
blockdiag		☑️	☑️	☑️
bpmn		☑️	☑️	☑️
bytefield				☑️
ditaa			☑️	☑️
erd			☑️	☑️
gnuplot	☑️		☑️	☑️	☑️
graphviz		☑️	☑️	☑️
meme	☑️		☑️
mermaid		☑️	☑️	☑️
msc			☑️	☑️
nomnoml				☑️
nwdiag		☑️	☑️	☑️
packetdiag		☑️	☑️	☑️
plantuml			☑️	☑️	☑️
rackdiag		☑️	☑️	☑️
seqdiag		☑️	☑️	☑️
shaape			☑️	☑️
smcat				☑️
svgbob				☑️
symbolator		☑️	☑️	☑️
syntrax		☑️	☑️	☑️
umlet	☑️	☑️	☑️	☑️
vega			☑️	☑️
vegalite			☑️	☑️
wavedrom			☑️	☑️

The example below illustrates the structure of a basic ditaa block written directly in an AsciiDoc document.

Basic ditaa block

[ditaa]
....
                   +-------------+
                   | Asciidoctor |-------+
                   |   diagram   |       |
                   +-------------+       | PNG out
                       ^                 |
                       | ditaa in        |
                       |                 v
 +--------+   +--------+----+    /---------------\
 |        | --+ Asciidoctor +--> |               |
 |  Text  |   +-------------+    |   Beautiful   |
 |Document|   |   !magic!   |    |    Output     |
 |     {d}|   |             |    |               |
 +---+----+   +-------------+    \---------------/
     :                                   ^
     |          Lots of work             |
     +-----------------------------------+
....

The ditaa block above results in the following generated diagram.

Rendered ditaa diagram

The rendered ditaa diagram above gets the file name 58372f7d2ceffae9e91fd0a7cbb080b6.png. That long number is the checksum of the source code calculated by asciidoctor-diagram. If you want to give your generated files a more meaningful name, fill in the target attribute.

This can be done by either specifying it as the second positional attribute or as a named attribute. Both examples below would result in a file called ditaa-diagram.png.

[ditaa, "ditaa-diagram"]
----
<snip>
----

[ditaa, target="ditaa-diagram"]
----
<snip>
----

The example below illustrates the structure of a basic PlantUML block written directly in an AsciiDoc document.

PlantUML Diagram Syntax

[plantuml, diagram-classes, png] // (1) (2) (3)
....
class BlockProcessor
class DiagramBlock
class DitaaBlock
class PlantUmlBlock

BlockProcessor <|-- DiagramBlock
DiagramBlock <|-- DitaaBlock
DiagramBlock <|-- PlantUmlBlock
....

1. The diagram is written in PlantUML so the first positional attribute is assigned the plantuml diagram type.

2. The name of the generated diagram file (target) is written in the second positional attribute.

3. The output format is entered in the third positional attribute.

Rendered PlantUML diagram

Generating a Diagram from a Terminal

You can load Asciidoctor diagram in a terminal using the -r flag.

$ asciidoctor -r asciidoctor-diagram sample.adoc

You can also use Asciidoctor diagram with other converters, such as Asciidoctor EPUB. Asciidoctor-epub3 is also loaded with the -r flag.

$ asciidoctor -r asciidoctor-diagram -r asciidoctor-epub3 -b epub3 sample.adoc

Or, you can invoke Asciidoctor and the EPUB converter with the asciidoctor-epub3 command. The command implicitly sets the -r and -b flags for EPUB3 output.

$ asciidoctor-epub3 -r asciidoctor-diagram sample.adoc

Advanced Usage

Enabling Extensions

In your program, you can either load and register the entire set of diagram extensions

require 'asciidoctor-diagram'

or load and register each extension individually.

require 'asciidoctor-diagram/<extension_name>'

<extension_name> can be one of a2s, blockdiag, bytefield, ditaa, erd, gnuplot, graphviz, meme, mermaid, msc, plantuml, shaape, smcat, svgbob, syntrax, umlet, vega or wavedrom.

Requiring one or more of these files will automatically register the extensions for all processed documents.

If you need more fine grained control over when the extensions are enabled, asciidoctor-diagram/<extension_name>/extension can be used instead. This loads the extensions but does not register it in the Asciidoctor extension registry. You can then manually register the extensions at the appropriate times using the Asciidoctor::Extensions API.

This document explains the various features of asciidoctor-diagram blocks using ditaa diagrams as an example.

Diagram Block Macro

The diagram extensions can also be used in in block macro form.

Anatomy of a diagram block macro

block-name::source-file-name[generated-file-extension] // (1) (2) (3)

1. The macro name is the same as the block name in the block form.

2. The source file name specifies the external file that contains the diagram source code.

3. The first, optional, positional attribute assigns the file extension (i.e. format) to the generated diagram.

When the source file name is a relative path it is resolved with respect to the location of the document being processed.

Image Output Location

When Asciidoctor Diagram writes images to disk it will go over the following options in order to determine where to write the files.

1. {imagesoutdir} if the imagesoutdir attribute has been specified

2. {outdir}/{imagesdir} if the outdir attribute has been specified

3. {to_dir}/{imagesdir} if the to_dir attribute has been specified

4. {base_dir}/{imagesdir}

Specifying Diagram Generator Paths

Asciidoctor Diagram depends on external tools to generates images. In most cases it will locate these tools automatically for you by looking for specific executables in each directory in the PATH environment variable. In case you’ve installed a tool in a way where the executable is not in the PATH, you can override its location manually using document attributes. The following table lists the tools that are required for each diagram type, the location where they can be downloaded and the document attribute you can use to override their locations.

Diagram Type	Tool	Attribute
a2s	AsciiToSvg	a2s
actdiag	ActDiag	actdiag
blockdiag	BlockDiag	blockdiag
bpmn	bpmn-js-cmd	bpmn
bytefield	bytefield-svg	bytefield-svg
ditaa	Java	java
erd	Erd	erd
gnuplot	Gnuplot	gnuplot
graphviz	GraphViz	dot or graphvizdot
meme	ImageMagick	convert and identify
mermaid	Mermaid.cli	mmdc
msc	Mscgen	mscgen
nomnoml	Nomnoml	nomnoml
nwdiag	NwDiag	nwdiag
packetdiag	NwDiag	packetdiag
plantuml	Java	java
rackdiag	NwDiag	rackdiag
seqdiag	SeqDiag	seqdiag
shaape	Shaape	shaape
smcat	State Machine Cat	smcat
svgbob	SvgBob	svgbob
symbolator	Symbolator	symbolator
syntrax	Syntrax	syntrax
umlet	Umlet	umlet
vega	vg2png and/or vg2png	vg2png and vg2svg
vegalite	vl2vg and vg2png and/or vg2svg	vl2vg, vg2png and vg2svg
wavedrom	WaveDrom Editor	wavedrom
	WaveDrom CLI (and PhantomJS for WaveDrom CLI v1)	wavedrom (and phantomjs)

If for instance you installed actdiag in /home/me/actdiag/bin and this path is not included in the PATH you can specify its location on the command line

$ asciidoctor -a actdiag=/home/me/actdiag/bin/actdiag -r asciidoctor-diagram sample.adoc

The Meme Extension

The meme extension provides a basic ‘Advice Animal’ style image generator. It’s usage is easiest to explain with an example.

meme::yunoguy.jpg[Doc writers,Y U NO // AsciiDoc]

The target of the block macro tells the extension which image to use as background. The first two positional attributes are top and bottom and are used for the top and bottom label. Occurrences of // surrounded by whitespace are interpreted as line breaks.

Diagram Attributes

Certain diagram types allow image generation to be customized using attributes. Each attribute can be specified per individual diagram block or for all blocks of a given diagram type in a document level. This is illustrated for the blockdiag fontpath attribute in the example below.

= Asciidoctor Diagram
:blockdiag-fontpath: /path/to/font.ttf (1)

[blockdiag] (2)
....
....

[blockdiag, fontpath="/path/to/otherfont.ttf"] (3)
....
....

1. Attributes can be specified for all diagram of a certain type at the document level by prefixing them with <blocktype>-. In this example, the fontpath attribute is specified for all diagrams of type blockdiag.

2. The first diagram does not specify an explicit value for fontpath so the global blockdiag-fontpath value will be used

3. The second diagram does specifie a fontpath value. This overrides the global blockdiag-fontpath value.

Each attribute can either be specified at the block level or at the document level. The attribute name at the block level should be prefixed with the name of the diagram type and a dash.

Shared Attributes

Name	Default value	Description
svg-type	unspecified	One of static, inline or interactive. This determines the style of SVG embedding that’s used in certain backends. The asciidoctor user guide describes this in more detail.

AsciiToSVG

Name	Default value	Description
fontfamily	unspecified	The font family to use in the generated SVG image
noblur	unspecified	Disable drop-shadow blurring

Blockdiag

Name	Default value	Description
fontpath	unspecified	The path to the font that should be used by blockdiag

BPMN

Name	Default value	Description
height	786	The target height of the diagram. Does not apply for output type svg.
width	1024	The target width of the diagram. Does not apply for output type svg.

Ditaa

Name	Default value	Description
scale	1	A scale factor that is applied to the image.
tabs	8	An integer value that specifies the tab size as a number of spaces.
background	FFFFFF	The background colour of the image. The format should be a six-digit hexadecimal number (as in HTML, FF0000 for red). Pass an eight-digit hex to define transparency.
antialias	true	Enables or disables anti-aliasing.
separation	true	Prevents the separation of common edges of shapes.
round-corners	false	Causes all corners to be rendered as round corners.
shadows	true	Enables or disable drop shadows.
debug	false	Renders the debug grid over the resulting image.
fixed-slope	false	Makes sides of parallelograms and trapezoids fixed slope instead of fixed width.
transparent	false	Makes the background of the image transparent instead of using the background color.

Gnuplot

Name	Default value	Description
background	unspecified	Background color, e.g. red, #FF0000. Does not work with txt.
height	unspecified	The height of the plot. Must be specified together with width.
width	unspecified	The width of the plot. Must be specified together with height.
crop	unspecified	Trims blank space from the edges of the completed plot (true/false). Does not work with svg, pdf.
transparent	unspecified	Generate transparent background (true/false). Does not work with svg, pdf, txt.
font	unspecified	The font face with optional font size to use for the text, e.g. font="Arial", font="Arial,11". Does not work with txt.
fontscale	unspecified	Scales all label for given factor. Does not work with txt.

GraphViz

Name	Default value	Description
layout	unspecified	The graphviz layout engine to use (dot -K option).

Meme

Name	Default value	Description
fill-color	white	The fill color for the text.
stroke-color	black	The outline color for the text
stroke-width	2	The width of the text outline.
font	Impact	The font face to use for the text.
options	unspecified	a comma separate list of flags that modify the image rendering. Currently only noupcase is supported which disable upper casing the labels.

Mermaid

Name	Default value	Description
background	FFFFFF	The background colour of the image. The format should be a six-digit hexadecimal number (as in HTML, FF0000 for red). Pass an eight-digit hex to define transparency.
css	unspecified	Path to a CSS file to pass to mermaid.
config	unspecified	Path to a JSON config file to pass to mermaid.
gantt-config	unspecified	Path to a gantt config file to pass to mermaid.
puppeteer-config	unspecified	Path to a puppeteer config file to pass to mermaid.
sequence-config	unspecified	Path to a sequence config file to pass to mermaid.
theme	unspecified	Theme of the chart, could be default, forest, dark or neutral.
width	unspecified	Width of the page.
height	unspecified	Height of the page.

Msc

Name	Default value	Description
font	unspecified	The name of the font that should be used by mscgen

PlantUML

Name	Default value	Description
config	unspecified	Path to a config file to pass to PlantUML.

State Machine Cat

Name	Default value	Description
direction	unspecifed	The direction of the state machine diagram. One of top-down, bottom-top, left-right or right-left.
engine	unspecified	The layout engine to use. One of dot, circo, fdp, neato, osage, or twopi

svgbob

Name	Default value	Description
font-family	arial	text will be rendered with this font
font-size	14	text will be rendered with this font size
scale	1	scale the entire svg (dimensions, font size, stroke width) by this factor
stroke-width	2	stroke width for all lines

Syntrax

Name	Default value	Description
heading	unspecifed	Diagram title
scale	1	A scale factor that is applied to the image.
style	unspecifed	Path to a style config file to pass to Syntrax.
transparent	false	Makes the background of the image transparent instead of opaque white.