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

Update n00b-syntaxReference.md

Browse Source
This commit is contained in:
Neil Cuzon
2021-05-02 02:43:13 -07:00
committed by GitHub
parent 390726ac03
commit 86f3153973
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/n00b-syntaxReference.md
View File

@@ -17,8 +17,7 @@ to save diagrams, there are a couple of ways,we recommend saving the diagram's d
| Diagram Breakers | Reason |Solution| | Diagram Breakers | Reason |Solution|
| --- | --- |---| | --- | --- |---|
| **Comments** | | | | **Comments** | | |
|[`%%{``}%%`](https://github.com/mermaid-js/mermaid/issues/1968) | Similar to [Directives](./directives.md) confuses the renderer.|To comment, just use `%%`|| |[`%%{``}%%`](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.|
| **Flow-Charts** | || | **Flow-Charts** | ||
|'end' | The word "End" can cause Flowcharts and Sequence diagrams to break |wrap them in quotation marks to prevent breakage| |'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| | [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|