Skip to content

↔️ 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.

License

asciidoctor/asciidoctor-diagram

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.

Asciidoctor Diagram

Linux Build Status macOS Build Status Windows 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]
----
              +-------------+
              | asciidoctor |-----------+
              |  diagram    |           |
              +-------------+           | image
                    ^                   |
                    | diagram source    |
                    |                   v
 +--------+   +-----+-------+    /---------------\
 |  adoc  |-->+ asciidoctor +    | HTML + image  |
 +--------+   +-------------+    \---------------/
----

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

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages