• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..23-Nov-2021-

LICENSEH A D31-Jul-202017.7 KiB340281

READMEH A D31-Jul-2020994 2819

README.mdH A D31-Jul-20202 KiB7352

action.phpH A D31-Jul-20201.3 KiB4427

deleted.filesH A D31-Jul-2020181 64

examplediagram.pngH A D31-Jul-20204.3 KiB

mermaid-override.cssH A D31-Jul-202030 33

mermaid.min.jsH A D31-Jul-2020740 KiB4215

plugin.info.txtH A D31-Jul-2020247 97

renderer.phpH A D31-Jul-20202.2 KiB8853

screnshotflowchart.pngH A D31-Jul-20204.8 KiB

syntax.phpH A D31-Jul-20204.3 KiB15589

README

1mermaidflowcharts Plugin for DokuWiki
2
3Create flowcharts and diagrams with an incredibly simple syntax
4
5All documentation for this plugin can be found at
6https://www.dokuwiki.org/plugin:flowcharts
7
8If you install this plugin manually, make sure it is installed in
9lib/plugins/mermaidflowcharts/ - if the folder is called different it
10will not work!
11
12Please refer to http://www.dokuwiki.org/plugins for additional info
13on how to install plugins in DokuWiki.
14
15----
16Copyright (C) Jakob Schwichtenberg <mail@jakobschwichtenberg.com>
17
18This program is free software; you can redistribute it and/or modify
19it under the terms of the GNU General Public License as published by
20the Free Software Foundation; version 2 of the License
21
22This program is distributed in the hope that it will be useful,
23but WITHOUT ANY WARRANTY; without even the implied warranty of
24MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25GNU General Public License for more details.
26
27See the LICENSING file for details
28

README.md

1# Flowcharts Plugin for DokuWiki
2
3
4Add flowcharts and diagrams to Dokuwiki with an intuitive syntax
5
6The diagrams and flowcharts are generated with https://mermaidjs.github.io/.
7
8**With the current version of the plugin it is crucial to remove the following lines from the Dokuwiki file conf/entities.conf**
9
10
11```
12<->     ↔
13->      →
14<-      ←
15---     —
16--      –
17```
18
19Otherwise, Dokuwiki will render -> to → and then the diagrams are not rendered correctly since, e.g. → is the wrong syntax and we need -> etc. (For more information, see https://www.dokuwiki.org/entities and also https://github.com/splitbrain/dokuwiki/blob/master/conf/entities.conf.)
20
21# Syntax
22
23```
24<flow>
25graph TD;
26    A-->B;
27    A-->C;
28    B-->D;
29    C-->D;
30</flow>
31```
32
33will be rendered to
34
35![example diagram](examplediagram.png)
36
37A nice feature is that each element of a diagram can be made clickable by using
38
39```
40<flow>
41graph TD;
42    A-->B;
43    A-->C;
44    B-->D;
45    C-->D;
46click A "SOMEPAGE"
47</flow>
48```
49Clicking on `A` will take you to http://yoururl.com/SOMEPAGE.
50
51For further details on the syntax, see https://mermaidjs.github.io/. Diagrams can be built in realtime using https://mermaidjs.github.io/mermaid-live-editor/.
52
53If you install this plugin manually, make sure it is installed in
54lib/plugins/mermaidflowcharts/ - if the folder is called different it
55will not work!
56
57Please refer to http://www.dokuwiki.org/plugins for additional info
58on how to install plugins in DokuWiki.
59
60----
61Plugin by Jakob Schwichtenberg http://jakobschwichtenberg.com
62
63This program is free software; you can redistribute it and/or modify
64it under the terms of the GNU General Public License as published by
65the Free Software Foundation; version 2 of the License
66
67This program is distributed in the hope that it will be useful,
68but WITHOUT ANY WARRANTY; without even the implied warranty of
69MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
70GNU General Public License for more details.
71
72See the LICENSING file for details
73