How to Use PlantUML With Markdown

Wed, 21 Oct 2026 21:00:00 +0000

PlantUML draws diagrams from text. Instead of dragging boxes around an editor, you write Customer -> Shop: Place order and PlantUML lays out the sequence diagram for you. Markdown is where most documentation lives. Put the two together and the diagram’s source sits in the same file as the text that explains it: it is reviewed in the same pull request, searched with the same tools, and never drifts away from the document because someone lost the original drawing.

Documentation Sites

Wed, 21 Oct 2026 17:55:00 +0000

Every project with users gets a documentation site: what it is, how to install and use it, and its reference. Heimdall’s documentation is one, and so is the documentation of my .NET libraries. They are all built the same way.

Concern	Choice
Generator	Hugo, extended edition
Theme	Docsy, as a Hugo module
Hosting	GitHub Pages
Deploys	GitHub Actions
DNS	Cloudflare, optional

Why Hugo

Hugo is a single binary that builds thousands of pages in about a second, and documentation is Markdown in a folder, next to the code it describes, reviewed in the same pull requests. Docsy is a documentation theme from Google with navigation, search and versioned sections built in.

Documentation on Artur Rios Lab

How to Use PlantUML With Markdown

Documentation Sites

Why Hugo