diff options
author | Robert Kaussow <mail@thegeeklab.de> | 2022-02-22 23:42:44 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-02-22 23:42:44 +0300 |
commit | 357417f8effe19760f9a0d4646f90254afc61bbd (patch) | |
tree | 1ced3b91a51b356a6e2c139c04dde585edb0f656 /exampleSite | |
parent | 591ee8d6df6b1376b58c72cc2dd15f9ec1ea9a33 (diff) |
docs: move mermaid shortcode documentation to shortcode page (#212)
Diffstat (limited to 'exampleSite')
-rw-r--r-- | exampleSite/content/posts/advanced/mermaid.md | 54 | ||||
-rw-r--r-- | exampleSite/content/posts/advanced/shortcodes.md | 49 | ||||
-rw-r--r-- | exampleSite/content/posts/usage/getting-started.md | 1 |
3 files changed, 48 insertions, 56 deletions
diff --git a/exampleSite/content/posts/advanced/mermaid.md b/exampleSite/content/posts/advanced/mermaid.md deleted file mode 100644 index bee9dce..0000000 --- a/exampleSite/content/posts/advanced/mermaid.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Mermaid -date: 2021-05-23T20:00:00+01:00 -authors: - - john-doe -tags: - - Documentation - - Shortcodes ---- - -[Mermaid](https://mermaidjs.github.io/) is library for generating SVG charts and diagrams from text. - -<!--more--> - -## Example - -{{< columns >}} - -<!-- prettier-ignore --> -```tpl -{{</* mermaid class="text-center"*/>}} -sequenceDiagram - Alice->>Bob: Hello Bob, how are you? - alt is sick - Bob->>Alice: Not so good :( - else is well - Bob->>Alice: Feeling fresh like a daisy - end - opt Extra response - Bob->>Alice: Thanks for asking - end -{{</* /mermaid */>}} -``` - -<---> - -<!-- spellchecker-disable --> -<!-- prettier-ignore --> -{{< mermaid class="text-center" >}} -sequenceDiagram - Alice->>Bob: Hello Bob, how are you? - alt is sick - Bob->>Alice: Not so good :( - else is well - Bob->>Alice: Feeling fresh like a daisy - end - opt Extra response - Bob->>Alice: Thanks for asking - end -{{< /mermaid >}} - -<!-- spellchecker-enable --> - -{{< /columns >}} diff --git a/exampleSite/content/posts/advanced/shortcodes.md b/exampleSite/content/posts/advanced/shortcodes.md index f7e95e2..b8b6efa 100644 --- a/exampleSite/content/posts/advanced/shortcodes.md +++ b/exampleSite/content/posts/advanced/shortcodes.md @@ -267,6 +267,53 @@ prompts feud gait, quid exercise emeritus bis e. In pro quints consequent. {{< /tab >}} {{< /tabs >}} +## Mermaid + +[Mermaid](https://mermaidjs.github.io/) is library for generating SVG charts and diagrams from text. + +<!--more--> + +### Example + +{{< columns >}} + +<!-- prettier-ignore --> +```tpl +{{</* mermaid class="text-center"*/>}} +sequenceDiagram + Alice->>Bob: Hello Bob, how are you? + alt is sick + Bob->>Alice: Not so good :( + else is well + Bob->>Alice: Feeling fresh like a daisy + end + opt Extra response + Bob->>Alice: Thanks for asking + end +{{</* /mermaid */>}} +``` + +<---> + +<!-- spellchecker-disable --> +<!-- prettier-ignore --> +{{< mermaid class="text-center" >}} +sequenceDiagram + Alice->>Bob: Hello Bob, how are you? + alt is sick + Bob->>Alice: Not so good :( + else is well + Bob->>Alice: Feeling fresh like a daisy + end + opt Extra response + Bob->>Alice: Thanks for asking + end +{{< /mermaid >}} + +<!-- spellchecker-enable --> + +{{< /columns >}} + ## KaTeX [KaTeX](https://katex.org/) shortcode let you render math typesetting in markdown document. @@ -293,7 +340,7 @@ f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi {{< /columns >}} -KaTeX can also be used inline, for example {{< katex >}}\pi(x){{< /katex >}} or used with the `display` parameter: +KaTeX can also be used inline, for example {{< katex >}}\pi(x){{< /katex >}} or used with the `display` parameter (e.g. `display: block`): <!-- spellchecker-disable --> <!-- prettier-ignore --> diff --git a/exampleSite/content/posts/usage/getting-started.md b/exampleSite/content/posts/usage/getting-started.md index 768fe12..6d418a5 100644 --- a/exampleSite/content/posts/usage/getting-started.md +++ b/exampleSite/content/posts/usage/getting-started.md @@ -259,5 +259,4 @@ There are a lot more things to discover. To get the most out of the Theme we hav - [Shortcodes](/posts/advanced/shortcodes/) - [Advanced Images](/posts/post-with-images/) - [Includes](/posts/advanced/includes/) - - [Mermaid](/posts/advanced/mermaid/) - [Table of Content](/posts/advanced/toc/) |