Skip to content

PlantUML Diagrams

PlantUML is a text-based diagramming tool that supports 13 distinct diagram types. Blocks use the plantuml fence identifier and must begin with @startuml / @enduml (or the equivalent for non-UML types).


Sequence Diagram

Models the chronological interaction between system actors. Useful for documenting API call flows and inter-service communication.

UserUserREST ControllerREST ControllerOPC UA ServiceOPC UA ServiceMongoDBMongoDBGET /nodesbrowseTree(ObjectsFolder)OpcUaNodeDto treesave(nodeSnapshot)OK200 JSON response

Class Diagram

Captures the static structure of a system — classes, attributes, methods, and relationships.

DiagramRendererrender(src: String): Stringvalidate(src: String): voidPlantUmlRendererexecPath: Stringrender(src: String): StringWireVizRendererrender(src: String): StringBlockDiagRendererrender(src: String): String

Activity Diagram

Represents the flow of control in a process — ideal for documenting build pipelines and data transformation steps.

Read Markdown sourceScan for fenced code blocksMatch block type (plantuml, wireviz...)Known type?yesnoCall rendererReplace block with SVGLeave block as code literalMore blocks?yesWrite HTML output

State Diagram

Documents the lifecycle of a connection or object — perfect for documenting OPC UA connection states.

DisconnectedConnectingConnectedSubscribingActiveconnect()timeout / errorsession establishedbrowseTree() donesubscriptions creatednetwork dropdata update received

Component Diagram

Shows the software component relationships and interfaces in an architecture.

mkdocs-kitThird-partycli.pyDiagramsPluginpdf.pyman.pyrenderers.pyplantumlWeasyPrintwireviz

Gantt Diagram

A scheduling tool for representing project timelines with tasks and dependencies.

Th1Fr2Sa3Su4Mo5Tu6We7Th8Fr9Sa10Su11Mo12Tu13We14Th15Fr16Sa17Su18Mo19Tu20We21Th22Fr23Sa24Su25Mo26Tu27We28Th29Fr30Sa31Su1January 2026Mo2Tu3We4Th5Fr6Sa7February 2026Design PhaseCore Plugin DevelopmentDiagram RenderersPDF & Man PagesTests and ValidationDocumentation

MindMap

A radial structure for capturing and organizing related concepts.

MkDocs-KitDiagram EnginesPlantUMLSequenceClassActivityGanttWireVizRackDiag / NwDiagPacketDiagByteField / BlockDiagOutput FormatsHTML (MkDocs Site)PDF (WeasyPrint)UNIX Man Pages