https://McShelby.github.io/hugo-theme-relearn/shortcodes/ Recent content in Shortcodes on Hugo Relearn Theme Hugo -- gohugo.io en https://McShelby.github.io/hugo-theme-relearn/shortcodes/children/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/children/ The children shortcode lists the child pages of the current page and its descendants . page X page 1 page 2 page 3 Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials. shortcode partial {{% children sort="weight" %}} {{ partial "shortcodes/children.html" (dict "context" . "sort" "weight" )}} Parameter Name Default Notes containerstyle ul Choose the style used to group all children. https://McShelby.github.io/hugo-theme-relearn/shortcodes/swagger/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/swagger/ This shortcode uses the RapiDoc library to display your Swagger / OpenAPI Specifications. Note This only works in modern browsers. Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials. shortcode partial {{< swagger src="https://petstore3.swagger.io/api/v3/openapi.json" >}} {{ partial "shortcodes/swagger.html" (dict "context" . "src" "https://petstore3.swagger.io/api/v3/openapi.json" )}} Parameter Name Default Notes src <empty> The URL to the OpenAPI Specification file. This can be relative to the URL of your page if it is a leaf or branch bundle. https://McShelby.github.io/hugo-theme-relearn/shortcodes/attachments/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/attachments/ The attachments shortcode displays a list of files attached to a page with adjustable color, title and icon. Attachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) hugo.png (17 KB) hugo.txt (20 B) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials. shortcode partial {{% attachments sort="asc" /%}} {{ partial "shortcodes/attachments.html" (dict "context" . https://McShelby.github.io/hugo-theme-relearn/shortcodes/button/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/button/ The button shortcode displays a clickable button with adjustable color, title and icon. Get Hugo Get Hugo Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials. shortcode partial {{% button href="https://gohugo.io/" %}}Get Hugo{{% /button %}} {{% button href="https://gohugo.io/" style="warning" icon="dragon" %}}Get Hugo{{% /button %}} {{ partial "shortcodes/button.html" (dict "context" . "href" "https://gohugo.io/" "content" "Get Hugo" )}} {{ partial "shortcodes/button. https://McShelby.github.io/hugo-theme-relearn/shortcodes/expand/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/expand/ The expand shortcode displays an expandable/collapsible section of text. Expand me... Thank you! Usage While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials. shortcode shortcode (positional) partial {{% expand title="Expand me..." %}}Thank you!{{% /expand %}} {{% expand "Expand me..." %}}Thank you!{{% /expand %}} {{ partial "shortcodes/expand.html" (dict "context" . "title" "Expand me..." "content" "Thank you! https://McShelby.github.io/hugo-theme-relearn/shortcodes/include/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/include/ The include shortcode includes other files from your project inside of the current page. Usage While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials. shortcode shortcode (positional) partial {{% include file="shortcodes/INCLUDE_ME.md" %}} {{% include "shortcodes/INCLUDE_ME.md" %}} {{ partial "shortcodes/include .html" (dict "context" . "file" "shortcodes/INCLUDE_ME.md" )}} The included files can even contain Markdown and will be taken into account when generating the table of contents. https://McShelby.github.io/hugo-theme-relearn/shortcodes/math/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/math/ The math shortcode generates beautiful formatted math and chemical formulae using the MathJax library. $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$ Note This only works in modern browsers. Usage While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable. https://McShelby.github.io/hugo-theme-relearn/shortcodes/mermaid/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/mermaid/ The mermaid shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the Mermaid library. graph LR; If --> Then Then --> Else Note This only works in modern browsers. Warning Due to limitations with Mermaid, it is currently not possible to use Mermaid code fences in an initially collapsed expand shortcode. This is a know issue and can’t be fixed by this theme. Usage While the examples are using shortcodes with named parameter it is recommended to use codefences instead. https://McShelby.github.io/hugo-theme-relearn/shortcodes/notice/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/notice/ The notice shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page. There may be pirates It is all about the boxes. Usage While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials. shortcode shortcode (positional) partial {{% notice style="primary" title="There may be pirates" icon="skull-crossbones" %}} It is all about the boxes. https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/ The siteparam shortcode prints values of site params. Usage While the examples are using shortcodes with named parameter you are free to use positional aswell or call this shortcode from your own partials. shortcode shortcode (positional) partial {{% siteparam name="editURL" %}} {{% siteparam "editURL" %}} {{ partial "shortcodes/siteparam.html" (dict "context" . "name" "editURL" )}} Parameter Name Position Default Notes name 1 <empty> The name of the site param to be displayed. https://McShelby.github.io/hugo-theme-relearn/shortcodes/tabs/ Mon, 01 Jan 0001 00:00:00 +0000 https://McShelby.github.io/hugo-theme-relearn/shortcodes/tabs/ The tabs shortcode displays arbitrary content in unlimited number of tabs. This comes in handy eg. for providing code snippets for multiple languages or providing configuration in different formats. python bash print("Hello World!") echo "Hello World!" Usage While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials. shortcode partial {{< tabs >}} {{% tab name="python" %}} ```python print("Hello World!") ``` {{% /tab %}} {{% tab name="bash" %}} ```bash echo "Hello World!