Skip to content

Commit 8b56a01

Browse files
committed
Add example to README.md
1 parent e3329f9 commit 8b56a01

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

README.md

+24-9
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
# AddMermaid
22

3-
Add mermaid.js redering for kanboard markdown texts.
3+
Add mermaid.js rendering for kanboard markdown texts.
4+
5+
See [mermaid.js](https://mermaid-js.github.io/mermaid/#/) for available diagram types and their syntax.
6+
7+
## Author
48

5-
Author
6-
------------
79
- Eugen Neuber
810
- License MIT
911

10-
Requirements
11-
------------
12+
## Requirements
13+
1214
Kanboard >= v1.0.48
1315
Kanboard installed at a web server.
1416
You can find the download at [kanboard.org](https://kanboard.org/)
1517

16-
Installation
17-
------------
18+
## Installation
19+
1820
Install this plugin by cloning this repository into kanboard plugin directory:
1921

2022
```console
@@ -27,6 +29,19 @@ Note: Plugin folder is case-sensitive.
2729

2830
### :star: If you like it, do not forget to give a star on GitHub!
2931

30-
:bug: Reporting Issues
31-
------------
32+
## Bug Reporting Issues
33+
3234
Please [create an issue](https://github.com/euneuber/AddMermaid/issues) for any bugs you've found.
35+
36+
## Example
37+
38+
Add this snippet to your markdown text:
39+
40+
```html
41+
<div class="mermaid">
42+
sequenceDiagram
43+
Alice->>John: Hello John, how are you?
44+
John-->>Alice: Great!
45+
Alice-)John: See you later!
46+
</div>
47+
```

0 commit comments

Comments
 (0)