What’s in This Section
Detailed syntax and examples for:
-
Flowchart diagrams
-
Sequence diagrams
-
Class diagrams
-
State diagrams
-
ER diagrams
-
User journey diagrams
-
Git graph diagrams
-
Pie charts
-
Gantt charts
-
Quadrant charts
-
Requirement diagrams
-
C4 diagrams
-
Mindmaps
-
Timeline diagrams
-
Sankey diagrams
-
XY charts
-
Block diagrams
-
Architecture diagrams
-
Kanban boards
Plus additional specialized types:
-
Radar charts
-
Treemap diagrams
-
Packet diagrams
-
Info diagrams
-
Error diagrams
Diagram Type Documentation Format
Each diagram type page includes:
-
Overview - What the diagram type is for
-
Use cases - When to use this type
-
Syntax specification - Complete syntax reference
-
Elements - Available node/element types
-
Relationships - Connection and edge types
-
Examples - From basic to advanced
-
Features - Special capabilities
-
Limitations - Current constraints
-
Best practices - Recommended usage patterns
Quick Reference
| Diagram Type | Primary Use Case | Keyword |
|---|---|---|
link:{% link _diagram_types/flowchart.adoc %}[Flowchart] |
Process flows and decision trees |
|
link:{% link _diagram_types/sequence-diagram.adoc %}[Sequence] |
Message interactions over time |
|
link:{% link _diagram_types/class-diagram.adoc %}[Class] |
Object-oriented design |
|
link:{% link _diagram_types/state-diagram.adoc %}[State] |
State machines |
|
link:{% link _diagram_types/er-diagram.adoc %}[ER Diagram] |
Database design |
|
link:{% link _diagram_types/user-journey.adoc %}[User Journey] |
User experience flows |
|
link:{% link _diagram_types/git-graph.adoc %}[Git Graph] |
Repository history |
|
link:{% link _diagram_types/pie-chart.adoc %}[Pie Chart] |
Proportional data |
|
link:{% link _diagram_types/gantt-chart.adoc %}[Gantt] |
Project timelines |
|
link:{% link _diagram_types/quadrant-chart.adoc %}[Quadrant] |
Priority matrices |
|
link:{% link _diagram_types/requirement-diagram.adoc %}[Requirement] |
Requirements traceability |
|
link:{% link _diagram_types/c4-diagram.adoc %}[C4] |
Software architecture |
|
link:{% link _diagram_types/mindmap.adoc %}[Mindmap] |
Hierarchical ideas |
|
link:{% link _diagram_types/timeline.adoc %}[Timeline] |
Historical events |
|
link:{% link _diagram_types/sankey-diagram.adoc %}[Sankey] |
Flow quantities |
|
link:{% link _diagram_types/xy-chart.adoc %}[XY Chart] |
Data plotting |
|
link:{% link _diagram_types/block-diagram.adoc %}[Block] |
Component relationships |
|
link:{% link _diagram_types/architecture-diagram.adoc %}[Architecture] |
System architecture |
|
link:{% link _diagram_types/kanban-diagram.adoc %}[Kanban] |
Workflow boards |
|
Choosing the Right Diagram Type
For Processes and Workflows
-
Flowchart - General process flows
-
Sequence - Time-based interactions
-
State - State transitions
-
User Journey - User experience flows
For Structure and Relationships
-
Class - Object relationships
-
ER Diagram - Data relationships
-
Block - Component relationships
-
Architecture - System structure
For Data Visualization
-
Pie Chart - Proportions
-
XY Chart - Data points
-
Sankey - Flow quantities
-
Quadrant - Priority/complexity matrices
Mermaid.js Compatibility
All diagram types maintain syntax compatibility with Mermaid.js. See link:{% link _pages/compatibility.adoc %}[Compatibility Guide] for detailed comparison.
Need Help?
-
Check link:{% link _tutorials/creating-first-diagram.adoc %}[Creating Your First Diagram] tutorial
-
See link:{% link _guides/best-practices.adoc %}[Best Practices] guide
-
Visit GitHub Issues for support