HowTo | Mermaid Guide

Mermaid

reference:

• Mermaid README

What is Mermaid

Mermaid lets you create diagrams and visualizations using text and code. It is a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically. ermaid is a JavaScript based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The main purpose of Mermaid is to help documentation catch up with development.

Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning. Mermaid addresses this problem by enabling users to create easily modifiable diagrams, it can also be made part of production scripts (and other pieces of code).

• Mermaid allows even non-programmers to easily create detailed and diagrams through the Mermaid Live Editor.

Supported Diagrams

Use Mermaid with your favorite applications, check out the list of Integrations and Usages of Mermaid.

• Flowchart
• Sequence diagram
• Gantt diagram
• Class diagram
• Git graph
• Entity Relationship Diagram
• User Journey Diagram

For a more detailed introduction to Mermaid and some of its more basic uses, look to the Beginner's Guide and Usage.

• Tutorials has video tutorials.