marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-08 10:06:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update n00b-syntaxReference.md

Browse Source
This commit is contained in:
Neil Cuzon
2020-07-20 11:39:23 -07:00
committed by GitHub
parent 56ed31ed6f
commit 815f398ada
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/n00b-syntaxReference.md
View File

@@ -3,8 +3,11 @@
If you are new to mermaid, read [Getting Started](n00b-gettingStarted.md) and [Overview](n00b-overview.md) sections, to learn the basics about the basics. If you are new to mermaid, read [Getting Started](n00b-gettingStarted.md) and [Overview](n00b-overview.md) sections, to learn the basics about the basics.
This section is a list of diagram types supported by mermaid, each one explains the syntax with which a diagram or chart can be called. 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.
These are called Diagram Definitions, since they describe the manner with which the diagram is to be rendered by the renderer.
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: ## mermaid tag:
These Diagram Definitions can be entered within a \<div class=mermaid> tag. These Diagram Definitions can be entered within a \<div class=mermaid> tag.
@@ -17,7 +20,7 @@ like so :
B-->D(fa:fa-spinner); B-->D(fa:fa-spinner);
</div> </div>
``` ```
## live ediotr ## mermaid Live Editor
These definitions can also be entered into the [mermaid live editor](https://mermaid-js.github.io/mermaid-live-editor), to render them immediately. These definitions can also be entered into the [mermaid live editor](https://mermaid-js.github.io/mermaid-live-editor), to render them immediately.
This would then offer This would then offer