Skip to content

Repository files navigation

Asciidoctor Diagram

Linux Build Status Gem Version

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 extension will run the appropriate diagram processor to generate an image from the input text. The generated image is then inserted into your converted document.

Detailed usage instructions can be found on the Asciidoctor documentation site.

Asciidoctor Diagram was inspired by the AsciiDoc PlantUML filter.

Example

The Asciidoctor Diagram enables you to embed a plain text diagram as a block in your document. The example below shows an embedded Ditaa diagram block.

[ditaa]
----
                         +-------------+
                         |   Diagram   +----------------+
                         |   Renderer  |                |
                         +-------------+                |
                         | Asciidoctor |                |
                         |   Diagram   |                |
                         +-------------+                | Image
                                ^                       |
                                | Diagram source        |
 +---------------+              |                       v
 |    Asciidoc   |       +------+------+        /-------+------\
 | with embedded +------>+ Asciidoctor +------->|   Beautiful  |
 |    diagram {d}|       +-------------+  HTML  |    Output    |
 +---------------+                              \--------------/
----

After processing by Asciidoctor, the output file will show a rendered version of the diagram instead of the diagram source code.

asciidoctor diagram process

About

↔️ Asciidoctor diagram extension, with support for AsciiToSVG, BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag), Ditaa, Erd, GraphViz, Mermaid, Msc, PlantUML, Shaape, SvgBob, Syntrax, UMLet, Vega, Vega-Lite and WaveDrom.

Resources

Code of conduct

Stars

479 stars

Watchers

19 watching

Forks

Releases

Packages

Used by

Contributors

Languages