Mermaid: Diagramming and charting tool

Mermaid is a Diagrams as Code tool for Diagramming and Charting. Mermaid offers a rich variety of diagram and chart options, including:

• Class Diagrams
• Entity Relationship Diagrams
• Flowcharts
• Gantt Diagrams
• Git Graphs
• Mindmaps
• Pie Charts
• Quadrant Chart
• Sequence Diagrams
• Timeline Diagrams

Example

The following mermaid markdown code block:

flowchart LR
  Start --> Stop

will produce the diagram:

Enabling Mermaid

When you choose Mermaid as an option, the following are added to the Starlight project:

1. Astro Mermaid is added as an Astro integration.
2. The mermaid dependency is added, which is used to render the Mermaid diagrams into images.