Create software diagrams using Mermaid syntax. Use when generating class diagrams, sequence diagrams, flowcharts, ERDs, state diagrams, git graphs, or gantt charts. For C4 architecture diagrams specifically, use c4-architecture instead.
Generate professional diagrams from text definitions. Mermaid renders in GitHub, GitLab, VS Code, Notion, and Obsidian natively.
| Need | Diagram Type | Reference |
|---|---|---|
| Domain modeling, OOP design | Class diagram | class-diagrams.md |
| API flows, auth sequences, interactions | Sequence diagram | sequence-diagrams.md |
| Processes, algorithms, user journeys | Flowchart | flowcharts.md |
| Database schemas, table relationships | ERD | erd-diagrams.md |
| System architecture (multi-level) | C4 diagram | c4-diagrams.md |
| Cloud infra, CI/CD, deployments | Architecture diagram | architecture-diagrams.md |
| Themes, styling, layout, export | Advanced features | advanced-features.md |
All diagrams follow: diagram type declaration, then definition content.
diagramType
definition content
Use %% for comments. First line declares type (classDiagram, sequenceDiagram, flowchart, erDiagram, C4Context, C4Container, C4Component, architecture-beta).
Quick examples and configuration: references/process.md
.mmd files alongside code for version control