← Back to Commentary and Essays

PlantUML for Your Website

PlantUML is useful when you want formal diagrams such as sequence diagrams, component diagrams, and other software-design views.

It works well when the diagram is part of a technical note or documentation page that should stay editable as text.

Simple example

@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi
@enduml

Authoritative sources

What you need to show it on your site

To display a live diagram, the site needs either a build step that turns the PlantUML source into SVG before publishing, or a browser-side renderer that loads the source and draws it at view time.

For permanent pages, the build-time SVG path is usually the best fit. It keeps the page stable, avoids script dependencies, and makes the diagram part of the published page rather than a runtime request.