File tree 1 file changed +24
-9
lines changed
1 file changed +24
-9
lines changed Original file line number Diff line number Diff line change 1
1
# AddMermaid
2
2
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
4
8
5
- Author
6
- ------------
7
9
- Eugen Neuber
8
10
- License MIT
9
11
10
- Requirements
11
- ------------
12
+ ## Requirements
13
+
12
14
Kanboard >= v1.0.48
13
15
Kanboard installed at a web server.
14
16
You can find the download at [ kanboard.org] ( https://kanboard.org/ )
15
17
16
- Installation
17
- ------------
18
+ ## Installation
19
+
18
20
Install this plugin by cloning this repository into kanboard plugin directory:
19
21
20
22
``` console
@@ -27,6 +29,19 @@ Note: Plugin folder is case-sensitive.
27
29
28
30
### :star : If you like it, do not forget to give a star on GitHub!
29
31
30
- : bug : Reporting Issues
31
- ------------
32
+ ## Bug Reporting Issues
33
+
32
34
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
+ ```
You can’t perform that action at this time.
0 commit comments