summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/Mermaid/docs/USAGE.md
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/extensions/Mermaid/docs/USAGE.md')
-rw-r--r--www/wiki/extensions/Mermaid/docs/USAGE.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/www/wiki/extensions/Mermaid/docs/USAGE.md b/www/wiki/extensions/Mermaid/docs/USAGE.md
new file mode 100644
index 00000000..b84ed126
--- /dev/null
+++ b/www/wiki/extensions/Mermaid/docs/USAGE.md
@@ -0,0 +1,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