diff --git a/docs/n00b-syntaxReference.md b/docs/n00b-syntaxReference.md index cec8f2d55..cdbf2e471 100644 --- a/docs/n00b-syntaxReference.md +++ b/docs/n00b-syntaxReference.md @@ -1,33 +1,50 @@ ## Diagram syntax +Diagram Syntax is not too tricky and there are guides for each type of Diagram. However, it requires some precision to render them correctly. +The [Getting Started](./n00b-gettingStarted.md) section can also provide some practical instances of using mermaid. -If you are new to mermaid, read the [Getting Started](n00b-gettingStarted.md) and [Overview](n00b-overview.md) sections, to learn the basics of mermaid. -Video Tutorials can be found at the bottom of the Overview Section. +Mermaid's syntax is used mainly to create and modify diagrams. + +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. + + +## Diagram Breaking + One should beware the use of some words or symbols that can ruin diagrams, and using avoid them. + + `%%{ }%%` These are +| Diagram Breakers | Reason |Solution| +| --- | --- |---| +| **Comments** | || +|`%%{` | Similar to [Directives](./directives.md) confuses the renderer.|| +|`}%%` | 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| +| | || -Below is a list of diagram types supported by mermaid and how they can be defined. -## mermaid tag -These Diagram Definitions can be entered within a \