3.2 KiB
Diagram Syntax
Mermaid's syntax is used to create diagrams.The next section dives deep into the syntax of each type,
Syntax, together with Deployment and Configuration constitute the whole of Mermaid.
Use the next section for reference and the Mermaid Live Editor as apractice area. Adittionally, the Getting Started section can also provide some practical examples of mermaid syntax.
You'll find that Mermaid's Syntax is not too tricky and it can be learned in a day.
Diagram Breaking
One should beware the use of some words or symbols that can break diagrams. These words or symbols are few and often only affect specific types of diagrams. The table below will continuously be updated.
| Diagram Breakers | Reason | Solution |
|---|---|---|
| Comments | ||
%%{``}%% |
Similar to Directives confuses the renderer. | In comments using %%, avoid using "{}". |
| 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 | Mermaid gets confused with nested shapes | wrap them in quotation marks to prevent breaking |
Mermaid Live Editor
Now, that you've seen what you should not add to your diagrams, you can play around with them in the Mermaid Live Editor.
Configuration
Configuration is the third part of Mermaid, after deployment and syntax. It deals with the different ways that Mermaid can be customized across different deployments.
If you are interested in altering and customizing your Mermaid Diagrams, you will find the methods and values available for Configuration here. It includes themes This section will introduce the different methods of configuring of the behaviors and apperances of Mermaid Diagrams. The Following are the most commonly used methods, and are all tied to Mermaid Deployment methods.
Configuration Section in the Live Editor.
Here you can edit certain values to change the behavior and appearance of the diagram.
The initialize() call,
Used when Mermaid is called via an API, or through a <script> tag.
Directives,
Allows for the limited reconfiguration of a diagram just before it is rendered. It can alter the font style, color and other aesthetic aspects of the diagram. you can pass a directive alongside your defintion inside %%{ }%%, either above or below your diagram defintion.
Theme Manipulation:
An application of using Directives to change Themes. Theme is an value within mermaid's configuration that dictates the color scheme for diagrams.