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 02:43:13 -07:00 committed by GitHub
parent 390726ac03
commit 86f3153973
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/n00b-syntaxReference.md
View File

@ -16,9 +16,8 @@ to save diagrams, there are a couple of ways,we recommend saving the diagram's d
`%%{ }%%` These are
| Diagram Breakers | Reason |Solution|
| --- | --- |---|
| **Comments** | ||
|[`%%{``}%%`](https://github.com/mermaid-js/mermaid/issues/1968) | Similar to [Directives](./directives.md) confuses the renderer.|To comment, just use `%%`||
| | Similar to [Directives](./directives.md) confuses the renderer.|
| **Comments** | | |
|[`%%{``}%%`](https://github.com/mermaid-js/mermaid/issues/1968) | Similar to [Directives](./directives.md) confuses the renderer.|To comment, just use `%%`|
| **Flow-Charts** | ||
|'end' | The word "End" can cause Flowcharts and Sequence diagrams to break |wrap them in quotation marks to prevent breakage|
| [Nodes inside Nodes](https://mermaid-js.github.io/mermaid/#/flowchart?id=special-characters-that-break-syntax)| Mermaid gets confused with nested shapes | wrap them in quotation marks to prevent breaking graph LR|