From 3a2a3296e08669be3760a34c5d918f1c37ed505b Mon Sep 17 00:00:00 2001 From: Goutte Date: Fri, 15 Mar 2019 21:36:30 +0100 Subject: [PATCH] Add a demo of mermaid to the README. --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e1a6c3fa8..87fad43a6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ # Courses -A flat-file database of courses in multiple languages. \ No newline at end of file +A flat-file database of courses in multiple languages. + + +### Mermaid demo + +You can use graphs in the courses : + + + ```mermaid + graph LR + subgraph Course + File[File] + end + + Student((Student)) + + Student --> |reads| File + ``` + +yields + +```mermaid +graph LR + subgraph Course + File[File] + end + + Student((Student)) + + Student --> |reads| File +``` \ No newline at end of file