🛠️Mermaid
Also known as Mermaid.js, Mermaid Diagram, Mermaid Diagrams
Diagrams written as short lines of text. The tool draws the picture for you.
Think of it like
It is like telling a friend who sits next to whom. They draw the seat map for you.
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.
Definition
Example code
mermaid
flowchart LR
A[Sign in] --> B{Password right?}
B -- Yes --> C[Home page]
B -- No --> ACommon mistake
Key takeaways
- 1Text to picture. Write lines, get a diagram.
- 2Lives in Markdown. GitHub and GitLab draw it in Markdown.
- 3Auto layout. You pick the links, it picks the places.