https://github.com/asciidoctor/asciidoctor-diagram

:left_right_arrow: 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.
https://github.com/asciidoctor/asciidoctor-diagram

Last synced: 3 days ago
JSON representation

:left_right_arrow: 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.

• Host: GitHub
• URL: https://github.com/asciidoctor/asciidoctor-diagram
• Owner: asciidoctor
• License: mit
• Created: 2014-02-05T21:10:23.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2024-10-13T19:44:49.000Z (3 months ago)
• Last Synced: 2024-10-30T00:00:40.664Z (2 months ago)
• Language: Ruby
• Homepage: http://asciidoctor.org
• Size: 204 MB
• Stars: 442
• Watchers: 25
• Forks: 107
• Open Issues: 36
• Metadata Files:
  • Readme: README.adoc
  • Changelog: CHANGELOG.adoc
  • License: LICENSE.txt

Awesome Lists containing this project

• my-awesome-github-stars - asciidoctor/asciidoctor-diagram - :left_right_arrow: Asciidoctor diagram extension, with support for AsciiToSVG, BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag), Ditaa, Erd, GraphViz, Mermaid, Msc, PlantUML, Shaape, SvgBob, Syntrax, U (Ruby)

README

        
= Asciidoctor Diagram

Pepijn Van_Eeckhoudt ; Sarah White 

:description: README for the Asciidoctor Diagram extension for Asciidoctor.

image:https://github.com/asciidoctor/asciidoctor-diagram/workflows/Linux%20unit%20tests/badge.svg?branch=main["Linux Build Status", link="https://github.com/asciidoctor/asciidoctor-diagram/actions?query=workflow%3A%22Linux+unit+tests%22"]

// image:https://github.com/asciidoctor/asciidoctor-diagram/workflows/macOS%20unit%20tests/badge.svg?branch=main["macOS Build Status", link="https://github.com/asciidoctor/asciidoctor-diagram/actions?query=workflow%3A%22macOS+unit+tests%22"]

// image:https://github.com/asciidoctor/asciidoctor-diagram/workflows/Windows%20unit%20tests/badge.svg?branch=main["Windows Build Status", link="https://github.com/asciidoctor/asciidoctor-diagram/actions?query=workflow%3A%22Windows+unit+tests%22"]

image:https://badge.fury.io/rb/asciidoctor-diagram.svg[Gem Version, link=https://rubygems.org/gems/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 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 https://docs.asciidoctor.org/diagram-extension/latest/[Asciidoctor documentation site].

Asciidoctor Diagram was inspired by the https://code.google.com/p/asciidoc-plantuml/[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 |

 +--------+       +-------------+  html  \--------------/

----

---------

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

image::docs/modules/ROOT/images/asciidoctor-diagram-process.png[]