mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-01-28 07:03:17 +08:00
1.5 KiB
1.5 KiB
Diagram syntax
Edit this Page 
If you are new to mermaid, read the Getting Started and Overview sections, to learn the basics of mermaid.
This section is a list of diagram types supported by mermaid. Below is a list of links to aricles that explain the syntax of the diagrams or charts that 0can be called.
They also detail how diagrams can be defined, or described in the manner with which the diagram is to be rendered by the renderer.
Benefits of a text based diagramming is its speed and modifiability, allowing easy maintenance and adaptations, over time. This allows your documentation to closely follow your code/project.
mermaid tag:
These Diagram Definitions can be entered within a <div class=mermaid> tag. like so :
<div class="mermaid">
graph LR
A --- B
B-->C[fa:fa-ban forbidden]
B-->D(fa:fa-spinner);
</div>
mermaid Live Editor
These definitions can also be entered into the mermaid live editor, to render them immediately. This would then offer