diff --git a/docs/intro/syntax-reference.md b/docs/intro/syntax-reference.md index 18548c3c9..9c51fbe4e 100644 --- a/docs/intro/syntax-reference.md +++ b/docs/intro/syntax-reference.md @@ -14,7 +14,13 @@ Diagram Examples can be found in the [Mermaid Live Editor](https://mermaid.live) ## Syntax Structure -One would notice that all **Diagrams definitions begin** with a declaration of the **diagram type**, followed by the definitions of the diagram and its contents. This declaration notifies the parser which kind of diagram the code is supposed to generate. +One would notice that all **Diagrams definitions begin** with a declaration of the **diagram type**, followed by the definitions of the diagram and its contents. This declaration notifies the parser which kind of diagram the code is supposed to generate. The only exception to this a [Frontmatter](#frontmatter-for-diagram-code) configuration. + +Code is case insensitive. Indents are completely ignored but recommended for structure and readability. + +Line comments can ignore anything on the line after '%% '. + +Unknown words and misspellings will break a diagram, while parameters silently fail. Strings shouldn't be quoted and will parse based on expected parameters. **Example** : The code below is for an Entity Relationship Diagram, specified by the `erDiagram` declaration. What follows is the definition of the different `Entities` represented in it. @@ -72,12 +78,54 @@ The following are the most commonly used methods, and they are all tied to Merma Here you can edit certain values to change the behavior and appearance of the diagram. +Each of these techniques are functionally equivalent, but better for different deployments. + ### [The initialize() call](./getting-started.md#_3-calling-the-javascript-api) Used when Mermaid is called via an API, or through a `