summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/Mermaid/docs/USAGE.md
blob: b84ed126f24b86328e4c8eac0cd50b53824b1f71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
This file contains basic *usage information* for the **Mermaid** extension. See also the [readme].

The `#mermaid` parser function allows to add [mermaid][mermaid] typed content to a wiki article. Copying,
[example syntax][examplemjs] is as easy as:

```
{{#mermaid:sequenceDiagram
participant Alice
participant Bob
  Alice->John: Hello John, how are you?
  loop Healthcheck
       John->John: Fight against hypochondria
  end
  Note right of John: Rational thoughts <br/>prevail...
    John-->Alice: Great!
    John->Bob: How about you?
    Bob-->John: Jolly good!
}}
```
![image](https://user-images.githubusercontent.com/1245473/34535703-14a32100-f106-11e7-9201-ea90a6286c58.png)

Further [examples][examplesmw] have been created on wiki.

[readme]: https://github.com/SemanticMediaWiki/Mermaid/blob/master/README.md
[mermaid]: https://github.com/knsv/mermaid
[examplemjs]: https://mermaidjs.github.io/
[examplesmw]: https://sandbox.semantic-mediawiki.org/wiki/Mermaid