From b62d43fb6618e59e64e8b6cd8314640b01ed9e62 Mon Sep 17 00:00:00 2001
From: Jeffrey Phillips Freeman <the@jeffreyfreeman.me>
Date: Sun, 29 Jan 2023 11:26:09 +0200
Subject: [PATCH] Added mermaid example to readme
---
.gitignore | 3 ++-
README.md | 29 ++++++++++++++++++++++++++---
2 files changed, 28 insertions(+), 4 deletions(-)
diff --git a/.gitignore b/.gitignore
index d107a90..c8efec8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
-README.pdf
+*.pdf
/plantuml-images
+*.err
diff --git a/README.md b/README.md
index 1ae4a37..bcb180b 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
+```
--
GitLab