mermaid/docs/n00b-syntaxReference.md

34 lines
1.2 KiB
Markdown
Raw Normal View History

2020-07-20 20:34:05 +02:00
## Diagram syntax
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.
2020-07-20 20:34:05 +02:00
2021-03-29 11:56:05 +02:00
Below is a list of diagram types supported by mermaid and how they can be defined.
2020-07-20 20:34:05 +02:00
2020-11-05 19:16:12 +01:00
## mermaid tag
2020-07-20 20:34:05 +02:00
These Diagram Definitions can be entered within a \<div class=mermaid> tag.
like so :
```html
2020-07-20 20:34:05 +02:00
<div class="mermaid">
graph LR
A --- B
B-->C[fa:fa-ban forbidden]
B-->D(fa:fa-spinner);
</div>
```
2021-01-22 08:41:03 +01:00
## Mermaid Live Editor
2021-03-29 11:56:05 +02:00
You can proofread or render and download your definitions in real-time with the [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor).
2021-01-22 08:41:03 +01:00
This would then offer you the following choices to download the diagram:
![Flowchart](./img/DownloadChoices.png)
**Note:** Copying the markdown will allow you to link to your unique diagram from anywhere online.
2021-01-22 08:41:03 +01:00
## Directives:
2021-03-29 12:01:28 +02:00
[Directives](./directives.md) allows 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.
2021-01-22 08:41:03 +01:00
## Theme Creation:
2021-03-29 12:01:28 +02:00
Mermaid allows you to change [Themes](./theming.md). This is also done using [Directives](./directives.md).
2021-01-22 08:41:03 +01:00
2019-11-28 12:53:33 +01:00