plantuml4idea

Intellij IDEA plugin for PlantUML

This plugin provides integration with popular PlantUML diagramming tool

Author: Eugene Steinberg

Contributors:

• Ivan Mamontov
• Henady Zakalusky
• Max Gorbunov
• Vojtěch Krása
• Andrew Korolev

Features

• PlantUML tool window renders PlantUML source code under caret in currently selected editor
• Supports multiple sources per file
• Supports pagination and zoom
• Can copy diagram to clipboard or export as PNG, EPS or SVG, ASCII Art
• Caching and incremental rendering

Tips

• PlantUML code must be inside @startuml and @enduml tags to be rendered.
• To be able to generate many diagram types, you must have Graphviz installed on your machine. About screen tests your installation.

Developer notes

• Project setup: gif mp4
• debug logs can be enabled by adding '#org.plantuml' to [Help | Debug Log Settings]

There are following branches:

master

• Current production branch

1.x

• deprecated branch, to be deleted

grammar

• Contains new experimental syntax support
• Grammar classes can be generated using tools/grammar-gen.sh
• This script can run automatically when you run the plugin using "Plugin" Run/Debug configuration. Just add the script above as an external tool and make it run before the "Make" step.

Mustache templating

A json file can be defined as a datasource to be templated into the puml file.

Example json:

{"person0":  "Jimmy", "person1":  "Timmy"}

Example usage:

'datasource=testData/template_properties.json
@startuml
!include https://raw.githubusercontent.com/TeliaSoneraNorge/C4-PlantUML/1.0.0/C4_Container.puml

Person(a, "{{personA}}")
Person(b, "{{personB}}")

@enduml