Skip to content
BENIBIX Learn

PlantUML vs Mermaid

People think PlantUML and Mermaid are the same tool with two names, and they are not. Both turn text into diagrams. Mermaid runs in the browser, and GitHub draws it right inside Markdown. PlantUML runs on Java and covers more of UML, but GitHub will not draw it for you. Pick Mermaid for a README, and PlantUML for strict UML.

Design🛠️ Design Tools

PlantUML

A free tool that turns lines of text into UML diagrams. You write it, and it draws it.

PlantUML is an open-source tool that draws diagrams from plain text. You write lines between @startuml and @enduml, and it draws the picture. It covers the common UML diagrams, such as sequence, class, activity and state. It also draws mind maps, Gantt charts and network maps. It runs on Java, and many wikis and code editors can show its diagrams.

Example
Lucy keeps a PlantUML sequence diagram of the checkout in her team's wiki. When the payment step changes, she edits one line and the picture redraws.
Why it matters
It draws strict UML from text, so the picture can live in Git and change with the code. Big teams use it to keep design pictures up to date.
Full entry
Design🛠️ Design Tools

Mermaid

Diagrams written as short lines of text. The tool draws the picture for you.

Mermaid is a way to make diagrams by writing short lines of text. You type a line like A --> B, and Mermaid draws box A with an arrow to box B. It can draw flowcharts, sequence diagrams, Gantt charts, class diagrams and many more. GitHub, GitLab and many note apps draw Mermaid inside Markdown files. Because the diagram is text, a change shows up in a code review like any other line.

Example
Emma adds a Mermaid flowchart to her project's README on GitHub. When the login steps change, she edits two lines of text, and the picture redraws.
Why it matters
The diagram lives beside the code and changes with it. Nobody needs a drawing tool to fix it.
Full entry

In one line

PlantUML
A free tool that turns lines of text into UML diagrams. You write it, and it draws it.
Mermaid
Diagrams written as short lines of text. The tool draws the picture for you.