Mermaid syntax guides

Mermaid Tutorials for Every Diagram Type

Learn each Mermaid syntax family with practical examples, clear decision guidance, production checklists, and copy-ready starter diagrams.

30 diagram guides
Copy-ready examples
Production checklists

Start with the essentials

Popular tutorial paths for docs, product flows, and architecture notes.

Browse Tutorials

Pick a diagram type, learn the syntax surface, and move from a small valid example to a publishable diagram.

Mermaid Flowchart

Flowchart

Flowcharts turn decisions, processes, and branches into readable Mermaid diagrams. They are the best starting point when you need to document a workflow, product funnel, or engineering process.

Product onboarding flowsBackend job pipelines
Mermaid Sequence Diagram

Sequence Diagram

Sequence diagrams show how participants communicate over time. Use them when the order of messages matters more than the internal structure of each system.

API documentationAuthentication flows
Mermaid Swimlanes

Swimlanes

Swimlane-style Mermaid diagrams separate responsibilities across teams, systems, or roles. They are useful when a process moves through multiple owners.

Cross-team approvalsCustomer support handoffs
Mermaid Class Diagram

Class Diagram

Class diagrams describe object models, relationships, methods, and attributes. They are useful for documenting domain models and object-oriented design.

Domain modelingSDK documentation
Mermaid State Diagram

State Diagram

State diagrams explain how an object, workflow, or UI moves between states. Use them when transitions and allowed events are the key information.

UI state machinesOrder and ticket lifecycles
Mermaid Entity Relationship Diagram

Entity Relationship Diagram

Entity relationship diagrams document database entities, attributes, and cardinality. They are ideal for explaining schema design and domain data relationships.

Database schema documentationProduct data modeling
Mermaid User Journey

User Journey

User journey diagrams describe what a user does, how they feel, and which teams or systems participate. They work well for product and UX documentation.

UX research summariesProduct onboarding
Mermaid Gantt Chart

Gantt Chart

Gantt charts show schedules, task durations, dependencies, and milestones. Use them for lightweight project plans that should live close to documentation.

Project timelinesLaunch plans
Mermaid Pie Chart

Pie Chart

Pie charts show part-to-whole relationships. Use them when a small number of categories add up to a meaningful total.

Budget breakdownsSurvey summaries
Mermaid Quadrant Chart

Quadrant Chart

Quadrant charts place items across two dimensions. They are useful for prioritization, positioning, and trade-off discussions.

Feature prioritizationMarket positioning
Mermaid Requirement Diagram

Requirement Diagram

Requirement diagrams connect requirements, elements, and relationships such as satisfies, verifies, and derives. They help teams trace why a system feature exists.

Compliance documentationSafety-critical systems
Mermaid Gitgraph

Gitgraph

Gitgraph diagrams visualize branches, commits, merges, and release flow. They are helpful for documenting Git workflows.

Release strategy documentationOnboarding engineers
Mermaid C4 Diagram

C4 Diagram

C4 diagrams describe software architecture at context, container, component, and code levels. They are useful when you need a shared architecture vocabulary.

Architecture reviewsSystem onboarding
Mermaid Mindmap

Mindmap

Mindmaps organize concepts around a central topic. They are useful for brainstorming, outlining documentation, and showing conceptual hierarchy.

Content outlinesProduct brainstorming
Mermaid Timeline

Timeline

Timeline diagrams explain events in chronological order. They work well for histories, release plans, and incident reports.

Incident reportsProject history
Mermaid ZenUML

ZenUML

ZenUML is a sequence-style syntax focused on readable interaction modeling. It is useful when you want compact service collaboration diagrams.

Service collaborationAPI interaction notes
Mermaid Sankey Diagram

Sankey Diagram

Sankey diagrams show weighted flow from one category to another. They are ideal for energy, money, traffic, and conversion flow.

Conversion funnelsBudget allocation
Mermaid XY Chart

XY Chart

XY charts display data across x and y axes. Mermaid supports simple bar and line style charts for documentation-friendly metrics.

Documentation metricsSimple trends
Mermaid Block Diagram

Block Diagram

Block diagrams show high-level parts and how they connect. They are useful for architecture sketches, hardware layouts, and conceptual systems.

System sketchesHardware layouts
Mermaid Packet Diagram

Packet Diagram

Packet diagrams document binary packet, protocol, and header layouts. They help readers understand field width and ordering.

Protocol documentationBinary format specs
Mermaid Kanban

Kanban

Kanban diagrams show work grouped by status. They are useful for lightweight planning snapshots in docs, issue reports, and project updates.

Project snapshotsEditorial planning
Mermaid Architecture Diagram

Architecture Diagram

Architecture diagrams show services, groups, and connections in a system. They are useful for infrastructure and platform overviews.

Cloud architecture overviewsPlatform onboarding
Mermaid Radar Chart

Radar Chart

Radar charts compare multiple dimensions for one or more subjects. They are useful for capability, maturity, and balanced scorecard views.

Capability assessmentProduct comparison
Mermaid Event Modeling

Event Modeling

Event modeling diagrams describe events, commands, views, and policies in event-driven systems. They help teams reason about behavior over time.

Event-driven architectureDomain modeling workshops
Mermaid Treemap

Treemap

Treemaps show hierarchical part-to-whole data. They are useful when categories have nested subcategories and relative size matters.

Content inventoriesBudget hierarchy
Mermaid Venn Diagram

Venn Diagram

Venn diagrams show overlap between sets. They are useful for explaining shared audiences, feature coverage, or category intersections.

Audience overlapFeature coverage
Mermaid Ishikawa Diagram

Ishikawa Diagram

Ishikawa diagrams, also called fishbone diagrams, organize possible causes of a problem. They are useful for root-cause analysis.

Incident reviewsQuality analysis
Mermaid Wardley Map

Wardley Map

Wardley maps connect user needs to capabilities and their evolution. They help with strategy, platform planning, and build-versus-buy decisions.

Platform strategyBuild-versus-buy analysis
Mermaid Cynefin Diagram

Cynefin Diagram

Cynefin diagrams classify situations by decision context, such as clear, complicated, complex, chaotic, and confused. They help teams choose an appropriate response.

Decision workshopsIncident response planning
Mermaid Tree View

Tree View

Tree views show hierarchical information in a compact, readable way. They are useful for file structures, taxonomies, and nested concepts.

Documentation structureNavigation planning