docs: Add mermaid shortcode

peaceiris · Feb 3, 2020 · 69a4e9f · 69a4e9f
1 parent a84700c
commit 69a4e9f
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -35,6 +35,7 @@ Hugo IRIS Theme
 - [Shortcodes](#shortcodes)
   - [button](#button)
   - [li](#li)
+  - [mermaid](#mermaid)
   - [repo](#repo)
   - [table](#table)
 - [Special Thanks](#special-thanks)
@@ -176,6 +177,26 @@ The following actions are useful to deploy your site to GitHub Pages using GitHu
 
 <img width="500px" src="https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/master/exampleSite/static/images/shortcode_li.jpg" alt="Shortcode li">
 
+### mermaid
+
+```md
+{{< mermaid >}}
+sequenceDiagram
+  participant Alice
+  participant Bob
+  Alice->>John: Hello John, how are you?
+  loop Healthcheck
+    John->>John: Fight against hypochondria
+  end
+  Note right of John: Rational thoughts <br/>prevail!
+  John-->>Alice: Great!
+  John->>Bob: How about you?
+  Bob-->>John: Jolly good!
+{{< /mermaid >}}
+```
+
+<img width="500px" src="https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/master/exampleSite/static/images/shortcode_mermaid.jpg" alt="Shortcode mermaid">
+
 ### repo
 
 ```md

diff --git a/exampleSite/static/images/shortcode_mermaid.jpg b/exampleSite/static/images/shortcode_mermaid.jpg