README
1wavedrom Plugin for DokuWiki
2
3Create wavedrom charts with an incredibly simple syntax
4
5All documentation for this plugin can be found at
6https://www.dokuwiki.org/plugin:wavedrom
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) Raymond Wu <wusixin@gmail.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# Wavedrom Plugin for DokuWiki
2
3
4Add wavedrom charts to Dokuwiki with an intuitive syntax
5
6The charts are generated with https://github.com/drom/wavedrom.
7
8# Syntax
9
10```
11<wavedrom>
12{ "signal" : [
13 { "name": "clk", "wave": "p.....|..." },
14 { "name": "Data", "wave": "x.345x|=.x", "data": ["head", "body", "tail", "data"] },
15 { "name": "Request", "wave": "0.1..0|1.0" },
16 {},
17 { "name": "Acknowledge", "wave": "1.....|01." }
18]}
19</wavedrom>
20```
21
22will be rendered to
23
24
25
26----
27Plugin by Raymond Wu <wusixin@gmail.com>
28
29This program is free software; you can redistribute it and/or modify
30it under the terms of the GNU General Public License as published by
31the Free Software Foundation; version 2 of the License
32
33This program is distributed in the hope that it will be useful,
34but WITHOUT ANY WARRANTY; without even the implied warranty of
35MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36GNU General Public License for more details.
37
38See the LICENSING file for details
39
