Mermaid syntax tutorial

Mermaid Mindmap Tutorial

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

Content outlinesProduct brainstormingLearning maps
Syntax

mindmap

Examples

1 starter pattern

Review

5 production checks

Open Mermaid Editor

Diagram preview

Rendered Mermaid example

Mindmap
Mermaid Mindmap example

What You Will Learn

How to recognize when Mindmap is the right Mermaid diagram, write the opening declaration, and shape a readable first version.

Best Fit

Content outlines, Product brainstorming, Learning maps.

Start Here

Copy the starter example, replace labels with your domain language, then simplify anything that does not help the reader.

Syntax Basics

Start with the diagram declaration, then add the smallest set of labels, relationships, and annotations needed to communicate the idea.

  • Use mindmap as the declaration.
  • Indent child nodes beneath parents.
  • Use shape markers for important nodes when needed.
  • Keep hierarchy shallow enough to scan.

Official Documentation Coverage

The Mermaid documentation for Mindmap covers the following syntax areas. This tutorial condenses those topics into practical guidance for day-to-day documentation.

Root node

Root node defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Indented hierarchy

Indented hierarchy is part of the official Mermaid Mindmap syntax surface. Add it when the starter example needs more precision for production documentation.

Square nodes

Square nodes defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Rounded nodes

Rounded nodes defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Circle nodes

Circle nodes defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Bang, cloud, and hexagon nodes

Bang, cloud, and hexagon nodes defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Default node styling

Default node styling defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

How This Tutorial Uses The Official Docs

Mermaid syntax evolves, so the official page remains the primary reference. This tutorial turns that reference material into an authoring workflow, review checklist, and production guidance.

Start with the official grammar

The official Mermaid Mindmap page is the source of truth for syntax changes. Use this tutorial to choose the right authoring pattern, then confirm exact keywords and edge cases in the official reference.

Prioritize the core sections

For the first pass, focus on Root node, Indented hierarchy, Square nodes, Rounded nodes. These sections usually explain the minimum structure required for a valid Mindmap.

Add advanced syntax only when it earns its space

Treat Circle nodes, Bang, cloud, and hexagon nodes, Default node styling as optional layers. They are valuable when the diagram needs precision, but they should not make the first version harder to read.

Syntax Reference Map

Use this map as a practical reading order for the official syntax page. It separates the first concepts to learn from the advanced details that are better added after the diagram already communicates the right idea.

Phase
How to use it
Start
Root node

Root node defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Does this root node detail make the mindmap easier to understand or maintain?

Start
Indented hierarchy

Indented hierarchy is part of the official Mermaid Mindmap syntax surface. Add it when the starter example needs more precision for production documentation.

Does this indented hierarchy detail make the mindmap easier to understand or maintain?

Refine
Square nodes

Square nodes defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Does this square nodes detail make the mindmap easier to understand or maintain?

Refine
Rounded nodes

Rounded nodes defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Does this rounded nodes detail make the mindmap easier to understand or maintain?

Refine
Circle nodes

Circle nodes defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Does this circle nodes detail make the mindmap easier to understand or maintain?

Polish
Bang, cloud, and hexagon nodes

Bang, cloud, and hexagon nodes defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Does this bang, cloud, and hexagon nodes detail make the mindmap easier to understand or maintain?

Polish
Default node styling

Default node styling defines the named objects in the diagram. Keep names stable, domain-specific, and short enough to remain readable in exported images.

Does this default node styling detail make the mindmap easier to understand or maintain?

How To Study The Official Syntax

The official Mermaid page is broad because it documents the full parser surface. For a working tutorial, read it in passes instead of trying to memorize every option at once.

Step 1

Skim the official Mindmap documentation once to understand the full syntax surface before copying examples into production docs.

Step 2

Focus first on Root node, Indented hierarchy, Square nodes, Rounded nodes, Circle nodes because these topics usually explain the core authoring model.

Step 3

After the first diagram renders, revisit the official styling, configuration, and advanced sections only when the diagram needs that extra precision.

Authoring Workflow

This workflow turns the official syntax reference into a repeatable writing process for docs, specs, and product pages.

Step 1

Frame the reader question

Before writing syntax, decide what question the Mindmap should answer. Good diagrams usually answer one question clearly instead of answering several partially.

Step 2

Draft the smallest valid diagram

Start with the declaration for mindmap, add only the required elements, and render it before introducing advanced styling or configuration.

Step 3

Add semantic labels

Replace placeholder names with business or system language that readers already know. Labels should reduce explanation work.

Step 4

Review for maintenance

Remove details that are likely to drift quickly. If a value, date, or dependency changes often, explain who owns the update.

Quick Syntax Cheat Sheet

Use this compact reference when you already know the goal and need to write a valid Mermaid Mindmap quickly.

Declaration
mindmap

Start the code block with mindmap so Mermaid selects the Mindmap renderer.

Core content
Use mindmap as the declaration.

Add the smallest number of statements that express the main idea before adding visual polish.

Connections
Connect the meaningful elements

Use connections only where they explain ownership, sequence, flow, dependency, or hierarchy.

Advanced topic
Root node

Use official syntax topics as optional layers, not as requirements for every diagram.

Practice Prompts

Use these prompts after reading the official syntax sections. They force the diagram to stay practical instead of becoming a syntax inventory.

Exercise 1

Create a Mindmap for content outlines using no more than eight visible elements.

Exercise 2

Rewrite the starter example with labels from your own product or engineering domain, then remove any line that does not change the reader's understanding.

Exercise 3

Add one official syntax feature from Root node, Indented hierarchy, Square nodes and explain why that feature makes the diagram clearer.

Exercise 4

Compare the result with tree-view and flowchart and write one sentence explaining why Mindmap is still the better fit.

Examples

Copy the example into the Mermaid editor, then adjust labels and relationships for your own documentation.

Documentation Outline

A simple mindmap for planning content.

mindmap
  root((Mermaid Tutorial))
    Basics
      Syntax
      Examples
    Practice
      Use cases
      Mistakes
    Publish
      SEO
      Sitemap

Example Walkthrough

Read Mermaid examples from top to bottom. The first meaningful line usually selects the diagram parser; the following lines add labels, relationships, values, states, or layout hints.

mindmap

This line declares the Mermaid diagram type, which tells Mermaid which parser and renderer to use.

root((Mermaid Tutorial))

This line contributes a label, item, or nested detail that Mermaid places into the diagram.

Basics

This line contributes a label, item, or nested detail that Mermaid places into the diagram.

Syntax

This line contributes a label, item, or nested detail that Mermaid places into the diagram.

Examples

This line contributes a label, item, or nested detail that Mermaid places into the diagram.

Practice

This line contributes a label, item, or nested detail that Mermaid places into the diagram.

Use cases

This line contributes a label, item, or nested detail that Mermaid places into the diagram.

Mistakes

This line contributes a label, item, or nested detail that Mermaid places into the diagram.

When To Use Mindmap

Content outlines
Product brainstorming
Learning maps
Feature planning

Diagram Choice Guide

A strong Mermaid tutorial should also explain when not to use the diagram type. Use this guide before adding a Mindmap to a public page or technical design document.

Use this diagram when

Mindmap works best for content outlines, product brainstorming, learning maps. It should make the reader's next decision easier, not merely decorate the page.

Choose a different diagram when

Your main question is better answered by another structure, such as tree-view, flowchart, kanban. For example, use a sequence diagram for message order and a flowchart for branching process logic.

Keep it maintainable by

Keeping the first version small, naming every important element with business language, and linking back to the official Mermaid syntax page when advanced syntax is required.

Production Checklist

Before publishing a Mermaid Mindmap, run through this checklist so the diagram remains useful after the immediate conversation is over.

Confirm that Mindmap is the right diagram type for the problem.
Start from the smallest example that communicates the idea clearly.
Use consistent names for nodes, actors, states, or data labels.
Check the diagram in the Mermaid editor before publishing.
Add surrounding text that explains assumptions, scale, or business context.

Production Review Questions

Before shipping the diagram in public docs, compare it against the official syntax page and then ask whether each line helps the reader make a better decision.

Does the first line clearly select the Mermaid Mindmap renderer with mindmap?
Are names and labels from the Root node area short, stable, and meaningful to the target reader?
Do the relationships, transitions, values, or hierarchy show real meaning instead of visual decoration?
Could a teammate update this diagram next month without rereading the whole surrounding document?

Troubleshooting

Most Mermaid issues come from an incorrect declaration, a syntax feature used before the base diagram works, or a diagram that is trying to communicate too many ideas at once.

The diagram does not render

Check that the first line is the correct declaration for Mindmap: mindmap. Then remove advanced lines until the smallest version renders.

The diagram renders but is hard to read

Shorten labels, reduce the number of visible items, and split separate ideas into separate diagrams.

The meaning is ambiguous

Add edge labels, relationship names, axis labels, or surrounding explanatory text so readers know what the diagram is proving.

The diagram becomes stale

Prefer stable concepts over volatile implementation details, and add ownership notes when the diagram documents a changing system.

Publishing Notes

For SEO and long-term documentation quality, keep the Mermaid code close to the explanation. Search engines can understand the surrounding text, while engineers can copy the exact syntax into their own editor.

If the diagram is used in a product page, add a short caption that states what decision the diagram supports. If it is used in internal docs, add ownership and update expectations so the diagram does not become stale after the system changes.

Best Practices

  • -Put one clear topic at the root.
  • -Use consistent indentation.
  • -Avoid very deep branches.
  • -Split large maps by theme.

Common Mistakes

  • -Using mindmaps for precise process order.
  • -Mixing unrelated themes under one root.
  • -Overloading nodes with long text.

Choosing Related Diagram Types

If Mindmap does not quite match your communication goal, compare it with these nearby Mermaid diagram types.

Tree View

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

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.

Kanban

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

FAQ

Is Mermaid Mindmap rendered on the server?

This tutorial page is server-rendered for SEO. The Mermaid syntax is shown as plain text so search engines and readers can inspect it without waiting for client-side rendering.

Can I edit this Mindmap example?

Yes. Open the Mermaid editor, paste the example, and modify the labels, relationships, or values for your own use case.