blob: 015e375554f54e8deef7fa124ed07c1179d05e80 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
pandoc-filter-plantuml
======================
A Pandoc AST filter rendering PlantUML code blocks into vector diagrams.
This filter produces TikZ code that must then be rendered using another filter such as
[tikz.py][tikz].
Usage
-----
A PlantUML diagram in an example Pandoc Markdown file `example.md`:
```puml
@startuml
Bob->Alice : hello
@enduml
```
Using the helper scripts [tikz.py][tikz] and `pandoc-filter-plantuml.sh`:
#/bin/sh
java -jar pandoc-filter-plantuml.jar <&0
Can be rendered and included as a vector resource in a PDF by running:
% pandoc --filter=pandoc-filter-plantuml.sh \
--filter=tikz.py \
--output=example.pdf \
example.md
Or as an image in an HTML document with the following command:
% pandoc --filter=pandoc-filter-plantuml.sh \
--filter=tikz.py \
--output=example.html \
example.md
Build
-----
The project can be built using the Gradle `build` task.
An autonomous jar file can be generated using the `jar` task.
License
-------
Project released under the terms of the GNU GPL v3.
See /license.txt
[tikz]: https://github.com/jgm/pandocfilters/blob/master/examples/tikz.py
|