mermaid/docs/n00b-syntaxReference.md

51 lines
2.9 KiB
Markdown
Raw Normal View History

2020-07-20 20:34:05 +02:00
## Diagram syntax
2021-05-02 09:59:57 +02:00
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.
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|
| | ||
2020-07-20 20:34:05 +02:00
2021-01-22 08:41:03 +01:00
## Mermaid Live Editor
2021-05-02 09:59:57 +02:00
Now, that you've seen what you should not add to your diagrams, you can play around with them in the [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor).
# Configuration
2021-01-22 08:41:03 +01:00
2021-05-02 09:59:57 +02:00
Configuration is the second half of Mermaid, after deployment. Together Deployment and Configuration constitute the whole of Mermaid.
2021-01-22 08:41:03 +01:00
2021-05-02 09:59:57 +02:00
If you are interested in altering and customizing your Mermaid Diagrams, you will find the methods and values available for [Configuration](./Setup.md) 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](./n00b-gettingStarted.md) methods.
2021-01-22 08:41:03 +01:00
2021-05-02 09:59:57 +02:00
## Configuration Section in the [Live Editor](./Live-Editor.md).
Here you can edit certain values to change the behavior and appearance of the diagram.
## The [initialize()](https://mermaid-js.github.io/mermaid/#/n00b-gettingStarted?id=_3-calling-the-javascript-api) call, for when Mermaid is called via an API, or through a <script> tag.
## [Directives](./directives.md),
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.
2021-01-22 08:41:03 +01:00
## Theme Creation:
2021-05-02 09:59:57 +02:00
An application of using Directives to change [Themes](./theming.md). `Theme` is an value within mermaid's configuration that dictates the color scheme for diagrams.
2021-01-22 08:41:03 +01:00
2019-11-28 12:53:33 +01:00