Installation instructions

Install the widget following installation instructions.

Video overview

Usage guide

Start typing the name of the widget…

… or select it from 'Select macro' pop up …

Enter the diagram’s name and plain text description, see the preview and save after you’re satisfied with results.

After pop up is closed diagram will appear on the page.

Tip: In the diagram editor, you'll see a "Diagram source" section where you can choose how to store your source code. The default option keeps everything inline, but you can switch to using attachments for better organization.

Diagram Source Storage Options

When creating or editing a PlantUML diagram, you can choose how to store the diagram source code:

Store source in macro (default)

Keep your diagram source code inline within the macro
Perfect for simple diagrams and quick edits
Source code is stored directly in the macro parameters

Use existing attachment

Select an existing PlantUML source file (.puml, .plantuml, .uml, or .txt) from your page attachments
The latest version of the attachment is automatically loaded when editing
Ideal for reusing diagram sources across multiple macros or pages
Enables better version control through Confluence's attachment versioning

Save as new attachment

Create a dedicated attachment file for your diagram source code
Enter a unique file name (e.g., architecture.puml)
Enables better organization, reuse, and collaboration
Leverages Confluence's built-in attachment versioning for change history

You can change the storage option before saving the diagram. Once saved, the option is locked to maintain consistency.

Diagram Images: All generated diagram images are stored as attachments to the page with full history of modifications.

Diagram Source: You can choose to store the PlantUML source code inline within the macro (default) or as a separate page attachment for better organization and reuse.

Validation and Error Handling

The app provides real-time validation to help you create valid diagrams:

Diagram name validation: Ensures your diagram image name is valid and unique
Source attachment name validation: Checks for valid file names and prevents duplicates when creating new attachments
PlantUML syntax validation: Displays clear error messages if your PlantUML code contains syntax errors
Visual feedback: Validation status indicators show whether your input is valid, invalid, or being checked

If you encounter a syntax error, the preview will display an error image with details about what needs to be corrected.

Live demo

See more examples on the Live Demo page.

Full language specification can be found on the PlantUML official website.