diff --git a/.gitignore b/.gitignore index d107a90ec04e91b65f676d54d9900750d7635160..c8efec8a4077650cbcdcdc1841ae5d8a5a9c34db 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ -README.pdf +*.pdf /plantuml-images +*.err diff --git a/README.md b/README.md index 1ae4a377cb73e14c79591f24c11843cd8c0aec2c..bcb180bd178db07279034e3d4777cb969d3d381c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ -Usage: +## Usage ```/bin/sh -docker run -w /foo -v "${PWD}:/foo" -it modjular/latex-pandoc-mermaid-plantuml pandoc -s -N README.md -o README.pdf --filter pandoc-plantuml +docker run -w /foo -v "${PWD}:/foo" --privileged -it modjular/latex-pandoc-mermaid-plantuml pandoc -s -N README.md -o README.pdf --filter pandoc-plantuml --filter mermaid-filter ``` -This is an example +## Examples + +This is an example of plantuml: + ```plantuml @startuml class Car @@ -13,3 +16,23 @@ Car *- Wheel : have 4 > Car -- Person : < owns @enduml ``` + +This is a mermaid example: + +```{.mermaid width=2000} +gantt + dateFormat YYYY-MM-DD + title Adding GANTT diagram functionality to mermaid + section A section + Completed task :done, des1, 2014-01-06,2014-01-08 + Active task :active, des2, 2014-01-09, 3d + Future task : des3, after des2, 5d + Future task2 : des4, after des3, 5d + section Critical tasks + Completed task in the critical line :crit, done, 2014-01-06,24h + Implement parser and jison :crit, done, after des1, 2d + Create tests for parser :crit, active, 3d + Future task in critical line :crit, 5d + Create tests for renderer :2d + Add to mermaid :1d +```