Mermaid syntax tutorial

Mermaid Pie Chart Tutorial

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

Budget breakdownsSurvey summariesTime allocation
Syntax

pie

Examples

1 starter pattern

Review

5 production checks

Diagram preview

Rendered Mermaid example

Pie Chart
Mermaid Pie Chart example

What You Will Learn

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

Best Fit

Budget breakdowns, Survey summaries, Time allocation.

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 pie as the diagram declaration.
  • Add showData when labels should include values.
  • Write each slice as "Label" : value.
  • Keep categories few enough to compare visually.

Official Documentation Coverage

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

Pie slices

Pie slices is part of the official Mermaid Pie Chart syntax surface. Add it when the starter example needs more precision for production documentation.

showData labels

showData labels is part of the official Mermaid Pie Chart syntax surface. Add it when the starter example needs more precision for production documentation.

Donut charts

Donut charts is part of the official Mermaid Pie Chart syntax surface. Add it when the starter example needs more precision for production documentation.

Legend position

Legend position is part of the official Mermaid Pie Chart syntax surface. Add it when the starter example needs more precision for production documentation.

Highlighted slices

Highlighted slices is part of the official Mermaid Pie Chart syntax surface. Add it when the starter example needs more precision for production documentation.

Configuration

Use Configuration after the diagram communicates the right structure. Styling should improve scanning and emphasis without hiding the underlying Mermaid syntax.

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 Pie Chart 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 Pie slices, showData labels, Donut charts, Legend position. These sections usually explain the minimum structure required for a valid Pie Chart.

Add advanced syntax only when it earns its space

Treat Highlighted slices, Configuration 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
Pie slices

Pie slices is part of the official Mermaid Pie Chart syntax surface. Add it when the starter example needs more precision for production documentation.

Does this pie slices detail make the pie chart easier to understand or maintain?

Start
showData labels

showData labels is part of the official Mermaid Pie Chart syntax surface. Add it when the starter example needs more precision for production documentation.

Does this showdata labels detail make the pie chart easier to understand or maintain?

Refine
Donut charts

Donut charts is part of the official Mermaid Pie Chart syntax surface. Add it when the starter example needs more precision for production documentation.

Does this donut charts detail make the pie chart easier to understand or maintain?

Refine
Legend position

Legend position is part of the official Mermaid Pie Chart syntax surface. Add it when the starter example needs more precision for production documentation.

Does this legend position detail make the pie chart easier to understand or maintain?

Refine
Highlighted slices

Highlighted slices is part of the official Mermaid Pie Chart syntax surface. Add it when the starter example needs more precision for production documentation.

Does this highlighted slices detail make the pie chart easier to understand or maintain?

Polish
Configuration

Use Configuration after the diagram communicates the right structure. Styling should improve scanning and emphasis without hiding the underlying Mermaid syntax.

Does this configuration detail make the pie chart 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 Pie Chart documentation once to understand the full syntax surface before copying examples into production docs.

Step 2

Focus first on Pie slices, showData labels, Donut charts, Legend position, Highlighted slices 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 Pie Chart 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 pie, 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 Pie Chart quickly.

Declaration
pie

Start the code block with pie so Mermaid selects the Pie Chart renderer.

Core content
Use pie as the diagram 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
Pie slices

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 Pie Chart for budget breakdowns 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 Pie slices, showData labels, Donut charts and explain why that feature makes the diagram clearer.

Exercise 4

Compare the result with xy-chart and radar and write one sentence explaining why Pie Chart is still the better fit.

Examples

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

Time Allocation

A simple part-to-whole breakdown.

pie showData
  title Project time
  "Development" : 45
  "Testing" : 20
  "Design" : 20
  "Meetings" : 15

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.

pie showData

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

title Project time

This line configures structure, labels, sections, participants, axes, or reusable diagram elements.

"Development" : 45

This line adds a relationship, transition, message, data value, or visual item to the diagram.

"Testing" : 20

This line adds a relationship, transition, message, data value, or visual item to the diagram.

"Design" : 20

This line adds a relationship, transition, message, data value, or visual item to the diagram.

"Meetings" : 15

This line adds a relationship, transition, message, data value, or visual item to the diagram.

When To Use Pie Chart

Budget breakdowns
Survey summaries
Time allocation
Category shares

Diagram Choice Guide

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

Use this diagram when

Pie Chart works best for budget breakdowns, survey summaries, time allocation. 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 xy-chart, radar, sankey. 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 Pie Chart, run through this checklist so the diagram remains useful after the immediate conversation is over.

Confirm that Pie Chart 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 Pie Chart renderer with pie?
Are names and labels from the showData labels 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 Pie Chart: pie. 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

  • -Use fewer than seven slices.
  • -Sort slices by value when possible.
  • -Avoid pie charts for close comparisons.
  • -Use clear category labels.

Common Mistakes

  • -Comparing many tiny slices.
  • -Using percentages that do not share one total.
  • -Choosing pie charts for time series data.

Choosing Related Diagram Types

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

FAQ

Is Mermaid Pie Chart 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 Pie Chart example?

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