aboutsummaryrefslogtreecommitdiff
path: root/exampleSite/content/docs/shortcodes
diff options
context:
space:
mode:
authorAlex Shpak <alex-shpak@users.noreply.github.com>2019-10-08 23:55:34 +0200
committerAlex Shpak <alex-shpak@users.noreply.github.com>2019-10-08 23:55:34 +0200
commitc7f93dc789da16ff03fa37b1c14ccc03c80e6b0a (patch)
treedac7298f9600cb14a51eb2a740e530ff2b29e6c5 /exampleSite/content/docs/shortcodes
parent1db63cef5cd631dd2fd73028183bc38ec816e92f (diff)
Update example file structure, give each shortcode own file
Diffstat (limited to 'exampleSite/content/docs/shortcodes')
-rw-r--r--exampleSite/content/docs/shortcodes/_index.md3
-rw-r--r--exampleSite/content/docs/shortcodes/buttons.md13
-rw-r--r--exampleSite/content/docs/shortcodes/columns.md45
-rw-r--r--exampleSite/content/docs/shortcodes/expand.md35
-rw-r--r--exampleSite/content/docs/shortcodes/hints.md32
-rw-r--r--exampleSite/content/docs/shortcodes/katex.md27
-rw-r--r--exampleSite/content/docs/shortcodes/mermaid.md38
-rw-r--r--exampleSite/content/docs/shortcodes/tabs.md50
8 files changed, 243 insertions, 0 deletions
diff --git a/exampleSite/content/docs/shortcodes/_index.md b/exampleSite/content/docs/shortcodes/_index.md
new file mode 100644
index 0000000..9bb0430
--- /dev/null
+++ b/exampleSite/content/docs/shortcodes/_index.md
@@ -0,0 +1,3 @@
+---
+bookFlatSection: true
+---
diff --git a/exampleSite/content/docs/shortcodes/buttons.md b/exampleSite/content/docs/shortcodes/buttons.md
new file mode 100644
index 0000000..b8c96bb
--- /dev/null
+++ b/exampleSite/content/docs/shortcodes/buttons.md
@@ -0,0 +1,13 @@
+# Buttons
+
+Buttons are styled links that can lead to local page or external link.
+
+```tpl
+{{</* button relref="/" [class="..."] */>}}Get Home{{</* /button */>}}
+{{</* button href="https://github.com/alex-shpak/hugo-book" */>}}Contribute{{</* /button */>}}
+```
+
+## Example
+
+{{< button relref="/" >}}Get Home{{< /button >}}
+{{< button href="https://github.com/alex-shpak/hugo-book" >}}Contribute{{< /button >}}
diff --git a/exampleSite/content/docs/shortcodes/columns.md b/exampleSite/content/docs/shortcodes/columns.md
new file mode 100644
index 0000000..4df396a
--- /dev/null
+++ b/exampleSite/content/docs/shortcodes/columns.md
@@ -0,0 +1,45 @@
+# Columns
+
+Columns help organize shorter pieces of content horizontally for readability.
+
+
+```html
+{{</* columns */>}} <!-- begin columns block -->
+# Left Content
+Lorem markdownum insigne...
+
+<---> <!-- magic sparator, between columns -->
+
+# Mid Content
+Lorem markdownum insigne...
+
+<---> <!-- magic sparator, between columns -->
+
+# Right Content
+Lorem markdownum insigne...
+{{</* /columns */>}}
+```
+
+## Example
+
+{{< columns >}}
+## Left Content
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+
+<--->
+
+## Mid Content
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter!
+
+<--->
+
+## Right Content
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+{{< /columns >}}
diff --git a/exampleSite/content/docs/shortcodes/expand.md b/exampleSite/content/docs/shortcodes/expand.md
new file mode 100644
index 0000000..c62520f
--- /dev/null
+++ b/exampleSite/content/docs/shortcodes/expand.md
@@ -0,0 +1,35 @@
+# Expand
+
+Expand shortcode can help to decrease clutter on screen by hiding part of text. Expand content by clicking on it.
+
+## Example
+### Default
+
+```tpl
+{{</* expand */>}}
+## Markdown content
+Lorem markdownum insigne...
+{{</* /expand */>}}
+```
+
+{{< expand >}}
+## Markdown content
+Lorem markdownum insigne...
+{{< /expand >}}
+
+### With Custom Label
+
+```tpl
+{{</* expand "Custom Label" "..." */>}}
+## Markdown content
+Lorem markdownum insigne...
+{{</* /expand */>}}
+```
+
+{{< expand "Custom Label" "..." >}}
+## Markdown content
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+{{< /expand >}}
diff --git a/exampleSite/content/docs/shortcodes/hints.md b/exampleSite/content/docs/shortcodes/hints.md
new file mode 100644
index 0000000..3477113
--- /dev/null
+++ b/exampleSite/content/docs/shortcodes/hints.md
@@ -0,0 +1,32 @@
+# Hints
+
+Hint shortcode can be used as hint/alerts/notification block.
+There are 3 colors to choose: `info`, `warning` and `danger`.
+
+```tpl
+{{</* hint [info|warning|danger] */>}}
+**Markdown content**
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+{{</* /hint */>}}
+```
+
+## Example
+
+{{< hint info >}}
+**Markdown content**
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+{{< /hint >}}
+
+{{< hint warning >}}
+**Markdown content**
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+{{< /hint >}}
+
+{{< hint danger >}}
+**Markdown content**
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+{{< /hint >}}
diff --git a/exampleSite/content/docs/shortcodes/katex.md b/exampleSite/content/docs/shortcodes/katex.md
new file mode 100644
index 0000000..965577f
--- /dev/null
+++ b/exampleSite/content/docs/shortcodes/katex.md
@@ -0,0 +1,27 @@
+# KaTeX
+
+KaTeX shortcode let you render math typesetting in markdown document. See [KaTeX](https://katex.org/)
+
+## Example
+{{< columns >}}
+
+```latex
+{{</* katex [class="text-center"] */>}}
+x = \begin{cases}
+ a &\text{if } b \\
+ c &\text{if } d
+\end{cases}
+{{</* /katex */>}}
+```
+
+<--->
+
+{{< katex >}}
+x = \begin{cases}
+ a &\text{if } b \\
+ c &\text{if } d
+\end{cases}
+{{< /katex >}}
+
+{{< /columns >}}
+
diff --git a/exampleSite/content/docs/shortcodes/mermaid.md b/exampleSite/content/docs/shortcodes/mermaid.md
new file mode 100644
index 0000000..3a617bc
--- /dev/null
+++ b/exampleSite/content/docs/shortcodes/mermaid.md
@@ -0,0 +1,38 @@
+# Mermaid Chart
+
+[Mermaid](https://mermaidjs.github.io/) is library for generating svg charts and diagrams from text.
+
+## Example
+
+{{< columns >}}
+```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 */>}}
+```
+
+<--->
+
+{{< mermaid >}}
+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 >}}
+
+{{< /columns >}}
diff --git a/exampleSite/content/docs/shortcodes/tabs.md b/exampleSite/content/docs/shortcodes/tabs.md
new file mode 100644
index 0000000..096892c
--- /dev/null
+++ b/exampleSite/content/docs/shortcodes/tabs.md
@@ -0,0 +1,50 @@
+# Tabs
+
+Tabs let you organize content by context, for example installation instructions for each supported platform.
+
+```tpl
+{{</* tabs "uniqueid" */>}}
+{{</* tab "MacOS" */>}} # MacOS Content {{</* /tab */>}}
+{{</* tab "Linux" */>}} # Linux Content {{</* /tab */>}}
+{{</* tab "Windows" */>}} # Windows Content {{</* /tab */>}}
+{{</* /tabs */>}}
+```
+
+## Example
+
+{{< tabs "uniqueid" >}}
+{{< tab "MacOS" >}}
+# MacOS
+
+This is tab **MacOS** content.
+
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+{{< /tab >}}
+
+{{< tab "Linux" >}}
+
+# Linux
+
+This is tab **Linux** content.
+
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+{{< /tab >}}
+
+{{< tab "Windows" >}}
+
+# Windows
+
+This is tab **Windows** content.
+
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+{{< /tab >}}
+{{< /tabs >}}