DOCSEARCHbyAlgolia
Submit Docs

PlantUML Integration Plugin for IntelliJ

repository·master·Indexed 20 days ago

https://github.com/esteinberg/plantuml4idea

A plugin for the IntelliJ platform that enables rendering, navigating, and exporting PlantUML diagrams directly within the IDE. Features include a dedicated tool window for real-time rendering, support for multiple sources per file, code navigation, and export options for PNG, EPS, SVG, and ASCII Art. Requires Graphviz for certain diagram types and supports AsciiMath via JLatexMath libraries.

Tokens
489
Snippets
1
Records
4
Agent score
22%

What's inside plantuml4idea

  1. Install and use the PlantUML plugin for IntelliJ

    master

    The PlantUML plugin integrates the PlantUML diagramming tool into the IntelliJ platform. It provides a dedicated tool window that renders PlantUML source code located under your caret in the active editor.

    Key capabilities include:

    • Rendering diagrams directly from source code.
    • Support for multiple sources within a single file.
    • Structure view, code navigation (declaration to usages), and renaming support.
    • Pagination and zoom controls.
    • Exporting diagrams to clipboard or files (PNG, EPS, SVG, or ASCII Art).
    • Caching and incremental rendering for performance.

  2. Configure PlantUML for diagram rendering

    master

    To ensure PlantUML diagrams render correctly, follow these requirements:

    1. Tagging: PlantUML code must be wrapped in @startuml and @enduml tags.

      @startuml
Alice -> Bob: Hello
@enduml

    2. Graphviz Requirement: To generate many diagram types, you must have Graphviz installed on your machine.

      • Note for Windows users: Graphviz is bundled in the PlantUML jar and is not required to be installed separately.
    @startuml
Alice -> Bob: Hello
@enduml

  3. Install AsciiMath support for PlantUML

    master

    To enable AsciiMath support within the plugin, follow these steps:

    1. Download the PlantUML jar from plantuml.com/download.
    2. Download the JLatexMath libraries from jar-download.com. Click the Download jlatexmath.jar (xxx) button and unzip the resulting jar_files.zip.
    3. Open IntelliJ settings and navigate to the PlantUML section.
    4. Set the PlantUML JAR path to the folder containing the downloaded jars.

  4. Enable debug logs for PlantUML

    master

    If you need to troubleshoot the plugin, you can enable debug logging by adding the following strings to the IntelliJ [Help | Debug Log Settings] menu:

    • #org.plantuml
    • org.plantuml

    Additionally, if you encounter UI bugs with a standard JDK, it is recommended to use the JetBrains JDK (JBR).