mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-10-08 00:29:39 +02:00
Adding to mermaid syntax
Following on from recommendation from code senior👌;
adding details to mermaid syntax in a more useful location;
- comments (tho not totally truethful)
- indenting
- case insensitive
- string handling
- expectations with invalid keywords or parameters
This commit is contained in:
@@ -8,7 +8,13 @@ Diagram Examples can be found in the [Mermaid Live Editor](https://mermaid.live)
|
|||||||
|
|
||||||
## Syntax Structure
|
## 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.
|
**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.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user