mirrors
/
mermaid
mirror of https://github.com/mermaid-js/mermaid.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update n00b-syntaxReference.md

This commit is contained in:
Neil Cuzon 2021-05-02 22:46:18 -07:00 committed by GitHub
parent 598dbeb185
commit b7fa328d95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/n00b-syntaxReference.md
View File

@ -1,18 +1,16 @@
# Diagram Syntax
Mermaid's syntax is used to create diagrams.
Mermaid's syntax is used to create diagrams.The next section dives deep into the syntax of each type,
Diagram Syntax is the next part of Mermaid. Syntax, together with Deployment and Configuration constitute the whole of Mermaid.
Syntax, together with Deployment and Configuration constitute the whole of Mermaid.
Mermaid's Syntax is not too tricky and there are thorough guides for each type of Diagram. However, it requires some precision to render them correctly.
Use the next section for reference. Adittionally, the [Getting Started](./n00b-gettingStarted.md) section can also provide some practical examples of mermaid syntax.
Use the next section for reference and the [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor) as apractice area. Adittionally, the [Getting Started](./n00b-gettingStarted.md) section can also provide some practical examples of mermaid syntax.
to save diagrams, there are a couple of ways,we recommend saving the diagram's definition along with the diagram itself, to make the diagram easy to edit.
You'll find that Mermaid's Syntax is not too tricky and it can be learned in a day.
## Diagram Breaking
One should beware the use of some words or symbols that can break diagrams, and using avoid them. Often these words or symbols only affect specific types of diagrams. The table below will continuously be updated.
One should beware the use of some words or symbols that can break diagrams. These words or symbols are few and often only affect specific types of diagrams. The table below will continuously be updated.
| Diagram Breakers | Reason |Solution|