PlantUML
PlantUML is a syntax and tool to draw UML diagrams, using a simple and human readable text description. It is particularly well-suited for users who prefer a simple, text-based approach to creating diagrams, and who want a tool that can automatically handle the layout and appearance of their diagrams.
To use PlantUML, an additional gem named asciidoctor-diagram-plantuml needs to be required. This gem makes the LGPL build of the PlantUML JAR files available to the Asciidoctor Diagram gem. When using this gem, Java version 1.8 or higher needs to be installed as well.
Alternatively, the native image build of PlantUML can be used as well.
This requires the plantuml-full or plantuml-headless binary to be available in the path.
Attributes
| Name | Default value | Description |
|---|---|---|
java |
java |
The path to the |
plantuml-native |
unspecified |
Path to a PlantUML native image binary. |
config |
unspecified |
Path to a config file to pass to PlantUML. |
theme |
unspecified |
PlantUML theme to use. |
size-limit |
4096 |
The maximum dimensions (width and height) of generated diagrams. |
includedir |
unspecified |
sets a common directory for puml includes (plantuml.include.path) |
preprocess |
true |
Preprocess PlantUML code before rendering the diagram. |