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.

PlantUML is automatically available via the asciidoctor-diagram-plantuml gem. This gem contains the LGPL build of PlantUML jar and its dependencies.

PlantUML requires Java version 1.8 or higher to be installed.

Supported Image Formats

  • PNG

  • SVG

  • TXT

Attributes

Name Default value Description

java

java

The path to the java executable

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.

Options

Name Description

debug

Emit debug files when generating images.

smetana

Enable the Smetana layout engine.