nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-10-27 18:53:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
hugo-theme-relearn/shortcodes/index.print.html
McShelby 8d86ba9fb6 deploy: a425a0680c
2022-11-12 22:22:15 +00:00

2509 lines
192 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="generator" content="Hugo 0.105.0">
<meta name="generator" content="Relearn 5.5.3+tip">
<meta name="description" content="Documentation for Hugo Relearn Theme">
<meta name="author" content="Sören Weber">
<title>Shortcodes :: Hugo Relearn Theme</title>
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/" rel="canonical" type="text/html" title="Shortcodes :: Hugo Relearn Theme">
<link href="../shortcodes/index.xml" rel="alternate" type="application/rss+xml" title="Shortcodes :: Hugo Relearn Theme">
<link href="../images/logo.svg?1668291725" rel="icon" type="image/svg+xml">
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="../css/fontawesome-all.min.css?1668291727" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fontawesome-all.min.css?1668291727" rel="stylesheet"></noscript>
<link href="../css/featherlight.min.css?1668291727" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/featherlight.min.css?1668291727" rel="stylesheet"></noscript>
<link href="../css/auto-complete.css?1668291727" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/auto-complete.css?1668291727" rel="stylesheet"></noscript>
<link href="../css/perfect-scrollbar.min.css?1668291727" rel="stylesheet">
<link href="../css/nucleus.css?1668291727" rel="stylesheet">
<link href="../css/fonts.css?1668291727" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fonts.css?1668291727" rel="stylesheet"></noscript>
<link href="../css/theme.css?1668291727" rel="stylesheet">
<link href="../css/theme-relearn-light.css?1668291727" rel="stylesheet" id="variant-style">
<link href="../css/ie.css?1668291727" rel="stylesheet">
<link href="../css/variant.css?1668291727" rel="stylesheet">
<link href="../css/print.css?1668291727" rel="stylesheet" media="print">
<link href="../css/format-print.css?1668291727" rel="stylesheet">
<script src="../js/variant.js?1668291727"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
window.index_js_url="../index.search.js";
var root_url="../";
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy to clipboard';
window.T_Copied_to_clipboard = 'Copied to clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
</script>
<script src="../js/jquery.min.js?1668291727" defer></script>
</head>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../shortcodes/">
<div id="body" class="default-animation">
<div id="sidebar-overlay"></div>
<div id="toc-overlay"></div>
<nav id="topbar" class="highlightable" dir="ltr">
<div>
<div class="navigation">
<a class="nav nav-next" href="../shortcodes/attachments/index.html" title="Attachments (&#129106;)"><i class="fas fa-chevron-right fa-fw"></i></a>
</div>
<div class="navigation">
<a class="nav nav-prev" href="../cont/tags/index.html" title="Tags (&#129104;)"><i class="fas fa-chevron-left fa-fw"></i></a>
</div>
<div id="top-print-link">
<a class="print-link" title='Print whole chapter (CTRL+ALT+p)' href="../shortcodes/index.print.html">
<i class="fas fa-print fa-fw"></i>
</a>
</div>
<div id="top-github-link">
<a class="github-link" title='Edit (CTRL+ALT+w)' href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/shortcodes/_index.en.md" target="blank">
<i class="fas fa-pen fa-fw"></i>
</a>
</div>
<div id="breadcrumbs">
<span id="sidebar-toggle-span">
<a href="#" id="sidebar-toggle" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
</span>
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li>
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Shortcodes</span><meta itemprop="position" content="2"></li>
</ol>
</div>
</div>
</nav>
<main id="body-inner" class="highlightable chapter narrow" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article class="chapter">
<div class="article-subheading">Chapter 3</div>
<h1>Shortcodes</h1>
<p>Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.</p>
<p>But this happens to be a bad idea. Everyone uses Markdown because it&rsquo;s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.</p>
<p>To avoid this limitations, Hugo created <a href="https://gohugo.io/extras/shortcodes/">shortcodes</a>. A shortcode is a simple snippet inside a page.</p>
<p>The Relearn theme provides multiple shortcodes on top of existing ones.</p>
<div class="children children-h2 children-sort-">
<h2><a href="../shortcodes/attachments/index.html">Attachments</a></h2><p>List of files attached to a page</p>
<h2><a href="../shortcodes/button/index.html">Button</a></h2><p>Clickable buttons</p>
<h2><a href="../shortcodes/children/index.html">Children</a></h2><p>List the child pages of a page</p>
<h2><a href="../shortcodes/expand/index.html">Expand</a></h2><p>Expandable/collapsible sections of text</p>
<h2><a href="../shortcodes/include/index.html">Include</a></h2><p>Displays content from other files</p>
<h2><a href="../shortcodes/math/index.html">Math</a></h2><p>Beautiful math and chemical formulae</p>
<h2><a href="../shortcodes/mermaid/index.html">Mermaid</a></h2><p>Generate diagrams and flowcharts from text</p>
<h2><a href="../shortcodes/notice/index.html">Notice</a></h2><p>Disclaimers to help you structure your page</p>
<h2><a href="../shortcodes/siteparam/index.html">Site param</a></h2><p>Get value of site params</p>
<h2><a href="../shortcodes/swagger/index.html">Swagger</a></h2><p>UI for your Swagger / OpenAPI Specifications</p>
<h2><a href="../shortcodes/tabs/index.html">Tabbed views</a></h2><p>Show content in tabbed views</p>
</div>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsections of Shortcodes</h1>
<article class="default">
<h1>Attachments</h1>
<p>The <code>attachments</code> shortcode displays a list of files attached to a page with adjustable color, title and icon.</p>
<div class="box attachments cstyle transparent">
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Attachments</div>
<ul class="box-content attachments-files">
<li><a href="../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
<li><a href="../shortcodes/attachments.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
<li><a href="../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
<li><a href="../shortcodes/attachments.en.files/hugo.png">hugo.png</a> (17 KB)</li>
<li><a href="../shortcodes/attachments.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
<li><a href="../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
</ul>
</div>
<h2 id="usage">Usage</h2>
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">attachments</span> <span class="nx">sort</span><span class="p">=</span><span class="s">&#34;asc&#34;</span> <span class="o">/%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/attachments.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;sort&#34;</span> <span class="s">&#34;asc&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<p>The shortcode lists files found in a specific folder.</p>
<p>Currently, it supports two implementations for pages</p>
<ol>
<li>
<p>If your page is a Markdown file, attachments must be placed in a folder named like your page and ending with <code>.files</code>.</p>
<blockquote>
<ul>
<li>content
<ul>
<li>_index.md</li>
<li><strong>page.files</strong>
<ul>
<li>attachment.pdf</li>
</ul>
</li>
<li>page.md</li>
</ul>
</li>
</ul>
</blockquote>
</li>
<li>
<p>If your page is a folder, attachments must be placed in a nested <code>files</code> folder.</p>
<blockquote>
<ul>
<li>content
<ul>
<li>_index.md</li>
<li>page
<ul>
<li>index.md</li>
<li><strong>files</strong>
<ul>
<li>attachment.pdf</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</blockquote>
</li>
</ol>
<p>Be aware that if you use a multilingual website, you will need to have as many folders as languages.</p>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>style</strong></td>
<td style="text-align:left"><code>transparent</code></td>
<td style="text-align:left">The color scheme used to highlight the box content.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code>&lt;nd color: <code>primary</code>, <code>secondary</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>,t`</td>
</tr>
<tr>
<td style="text-align:left"><strong>title</strong></td>
<td style="text-align:left">see notes</td>
<td style="text-align:left">Arbitrary text for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwault.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: <code>Attachments</code><br><br>If you wa you have to set this parameter to <code>&quot; &quot;</code> (a non empty string filled with spaces)</td>
</tr>
<tr>
<td style="text-align:left"><strong>icon</strong></td>
<td style="text-align:left">see notes</td>
<td style="text-align:left"><a href="../cont/icons/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending le** there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching iseverity<br>- for all other colors: <code>paperclip</code><br><br>If you want no icon, you have to set this parameter to <code>&quot; &quot;</code> (a non empty d with spaces)</td>
</tr>
<tr>
<td style="text-align:left"><strong>sort</strong></td>
<td style="text-align:left"><code>asc</code></td>
<td style="text-align:left">Sorting the output in <code>asc</code>ending or <code>desc</code>ending order.</td>
</tr>
<tr>
<td style="text-align:left"><strong>pattern</strong></td>
<td style="text-align:left"><code>.*</code></td>
<td style="text-align:left">A <a href="https://en.wikipedia.org/wiki/Regular_expression">regular expressions</a>, used to filter the attachments by file name. For example:<br><br>- to match a file suffix of &lsquo;jpg&rsquo;, use <code>.*jpg</code> (not <code>*.jpg</code>)<br>- to match file names ending in <code>jpg</code> or <code>png</code>, use <code>.*(jpg|png)</code></td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<h3 id="custom-title-list-of-attachments-ending-in-pdf-or-mp4">Custom Title, List of Attachments Ending in pdf or mp4</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">attachments</span> <span class="nx">title</span><span class="p">=</span><span class="s">&#34;Related files&#34;</span> <span class="nx">pattern</span><span class="p">=</span><span class="s">&#34;.*(pdf|mp4)&#34;</span> <span class="o">/%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box attachments cstyle transparent">
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Related files</div>
<ul class="box-content attachments-files">
<li><a href="../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
<li><a href="../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
<li><a href="../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
</ul>
</div>
<h3 id="info-styled-box-descending-sort-order">Info Styled Box, Descending Sort Order</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">attachments</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;info&#34;</span> <span class="nx">sort</span><span class="p">=</span><span class="s">&#34;desc&#34;</span> <span class="o">/%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box attachments cstyle info">
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
<ul class="box-content attachments-files">
<li><a href="../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
<li><a href="../shortcodes/attachments.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
<li><a href="../shortcodes/attachments.en.files/hugo.png">hugo.png</a> (17 KB)</li>
<li><a href="../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
<li><a href="../shortcodes/attachments.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
<li><a href="../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
</ul>
</div>
<h3 id="style-and-icons">Style and Icons</h3>
<p>For further examples for <strong>style</strong>, <strong>title</strong> and <strong>icon</strong>, see the <a href="../shortcodes/notice/"><code>notice</code> shortcode</a> documentation. The parameter are working the same way for both shortcodes, besides having different defaults.</p>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>Button</h1>
<p>The <code>button</code> shortcode displays a clickable button with adjustable color, title and icon.</p>
<p>
<span class="btn cstyle transparent">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
</a>
</span>
<span class="btn cstyle warning">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
<i class="fa-fw fas fa-dragon"></i>
Get Hugo
</a>
</span></p>
<h2 id="usage">Usage</h2>
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;warning&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;dragon&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/button.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;href&#34;</span> <span class="s">&#34;https://gohugo.io/&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;content&#34;</span> <span class="s">&#34;Get Hugo&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/button.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;href&#34;</span> <span class="s">&#34;https://gohugo.io/&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;style&#34;</span> <span class="s">&#34;warning&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;icon&#34;</span> <span class="s">&#34;dragon&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;content&#34;</span> <span class="s">&#34;Get Hugo&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<p>Once the button is clicked, it opens another browser tab for the given URL.</p>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>href</strong></td>
<td style="text-align:left"><em>&lt;empty&gt;</em></td>
<td style="text-align:left">The destination URL for the button. If this parameter is not set, the button will do nothing but is still displayed as clickable.</td>
</tr>
<tr>
<td style="text-align:left"><strong>style</strong></td>
<td style="text-align:left"><code>transparent</code></td>
<td style="text-align:left">The color scheme used to paint the button.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code></td>
</tr>
<tr>
<td style="text-align:left"><strong>icon</strong></td>
<td style="text-align:left">see notes</td>
<td style="text-align:left"><a href="../cont/icons/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other colors: <em>&lt;empty&gt;</em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>&quot; &quot;</code> (a non empty string filled with spaces)</td>
</tr>
<tr>
<td style="text-align:left"><strong>iconposition</strong></td>
<td style="text-align:left"><code>left</code></td>
<td style="text-align:left">Places the icon to the <code>left</code> or <code>right</code> of the title.</td>
</tr>
<tr>
<td style="text-align:left"><strong>target</strong></td>
<td style="text-align:left">see notes</td>
<td style="text-align:left">The destination frame/window for the URL. This behaves similar to normal links. If the parameter is not given it defaults to:<br><br>- <code>_blank</code> for any address starting with <code>http://</code> or <code>https://</code><br>- no specific value for all other links</td>
</tr>
<tr>
<td style="text-align:left"><em><strong>&lt;content&gt;</strong></em></td>
<td style="text-align:left">see notes</td>
<td style="text-align:left">Arbitrary text for the button title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: <em>&lt;empty&gt;</em><br><br>If you want no title for a severity style, you have to set this parameter to <code>&quot; &quot;</code> (a non empty string filled with spaces)</td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<h3 id="style">Style</h3>
<h4 id="by-severity">By Severity</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;info&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;note&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;tip&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;warning&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div><p>
<span class="btn cstyle info">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
<i class="fa-fw fas fa-info-circle"></i>
Get Hugo
</a>
</span>
<span class="btn cstyle note">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
<i class="fa-fw fas fa-exclamation-circle"></i>
Get Hugo
</a>
</span>
<span class="btn cstyle tip">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
<i class="fa-fw fas fa-lightbulb"></i>
Get Hugo
</a>
</span>
<span class="btn cstyle warning">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
<i class="fa-fw fas fa-exclamation-triangle"></i>
Get Hugo
</a>
</span></p>
<h4 id="by-brand-colors">By Brand Colors</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;primary&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;secondary&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div><p>
<span class="btn cstyle primary">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
</a>
</span>
<span class="btn cstyle secondary">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
</a>
</span></p>
<h4 id="by-color">By Color</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;blue&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;green&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;grey&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;orange&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;red&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div><p>
<span class="btn cstyle blue">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
</a>
</span>
<span class="btn cstyle green">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
</a>
</span>
<span class="btn cstyle grey">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
</a>
</span>
<span class="btn cstyle orange">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
</a>
</span>
<span class="btn cstyle red">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
</a>
</span></p>
<h4 id="by-special-color">By Special Color</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;default&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;transparent&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div><p>
<span class="btn cstyle default">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
</a>
</span>
<span class="btn cstyle transparent">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
</a>
</span></p>
<h3 id="icon">Icon</h3>
<h4 id="to-the-left">To the Left</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;download&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<span class="btn cstyle transparent">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
<i class="fa-fw fas fa-download"></i>
Get Hugo
</a>
</span>
<h4 id="to-the-right">To the Right</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;download&#34;</span> <span class="nx">iconposition</span><span class="p">=</span><span class="s">&#34;right&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<span class="btn cstyle transparent">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo
<i class="fa-fw fas fa-download"></i>
</a>
</span>
<h4 id="override-for-severity">Override for Severity</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;dragon&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;warning&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<span class="btn cstyle warning">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
<i class="fa-fw fas fa-dragon"></i>
Get Hugo
</a>
</span>
<h3 id="target">Target</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">target</span><span class="p">=</span><span class="s">&#34;_self&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span> <span class="nx">in</span> <span class="nx">same</span> <span class="nx">window</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Hugo</span> <span class="nx">in</span> <span class="nx">new</span> <span class="nx">Window</span><span class="o">/</span><span class="nf">Frame</span> <span class="p">(</span><span class="k">default</span><span class="p">){{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div><p>
<span class="btn cstyle transparent">
<a href="https://gohugo.io/" target="_self" rel="noopener">
Get Hugo in same Window/Frame
</a>
</span>
<span class="btn cstyle transparent">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
Get Hugo in new Window/Frame (default)
</a>
</span></p>
<h3 id="other">Other</h3>
<h4 id="severity-style-with-all-defaults">Severity Style with all Defaults</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;https://gohugo.io/&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;tip&#34;</span> <span class="o">%</span><span class="p">}}{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<span class="btn cstyle tip">
<a href="https://gohugo.io/" target="_blank" rel="noopener">
<i class="fa-fw fas fa-lightbulb"></i>
Tip
</a>
</span>
<h4 id="button-to-internal-page">Button to internal page</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">&#34;/&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Home</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<span class="btn cstyle transparent">
<a href="../">
Home
</a>
</span>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>Children</h1>
<p>The <code>children</code> shortcode lists the child pages of the current page and its descendants .</p>
<ul class="children children-li children-sort-weight">
<li><a href="../shortcodes/children/test/index.html">page X</a></li>
<li><a href="../shortcodes/children/children-1/index.html">page 1</a></li>
<li><a href="../shortcodes/children/children-2/index.html">page 2</a></li>
<li><a href="../shortcodes/children/children-3/index.html">page 3</a></li>
</ul>
<h2 id="usage">Usage</h2>
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">sort</span><span class="p">=</span><span class="s">&#34;weight&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/children.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;sort&#34;</span> <span class="s">&#34;weight&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>containerstyle</strong></td>
<td style="text-align:left"><code>ul</code></td>
<td style="text-align:left">Choose the style used to group all children. It could be any HTML tag name.</td>
</tr>
<tr>
<td style="text-align:left"><strong>style</strong></td>
<td style="text-align:left"><code>li</code></td>
<td style="text-align:left">Choose the style used to display each descendant. It could be any HTML tag name.</td>
</tr>
<tr>
<td style="text-align:left"><strong>showhidden</strong></td>
<td style="text-align:left"><code>false</code></td>
<td style="text-align:left">When <code>true</code>, child pages hidden from the menu will be displayed as well.</td>
</tr>
<tr>
<td style="text-align:left"><strong>description</strong></td>
<td style="text-align:left"><code>false</code></td>
<td style="text-align:left">When <code>true</code> shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - <a href="https://gohugo.io/content/summaries/">read more info about summaries on gohugo.io</a>.</td>
</tr>
<tr>
<td style="text-align:left"><strong>depth</strong></td>
<td style="text-align:left"><code>1</code></td>
<td style="text-align:left">The depth of descendants to display. For example, if the value is <code>2</code>, the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. <code>999</code>.</td>
</tr>
<tr>
<td style="text-align:left"><strong>sort</strong></td>
<td style="text-align:left">see notes</td>
<td style="text-align:left">The sort order of the displayed list.<br><br>If not set it is sorted by the <a href="../basics/configuration/#global-site-parameters"><code>ordersectionsby</code></a> setting of the site and the pages frontmatter<br><br>- <code>weight</code>: to sort on menu order<br>- <code>title</code>: to sort alphabetically on menu label.</td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<h3 id="all-default">All Default</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<ul class="children children-li children-sort-">
<li><a href="../shortcodes/children/test/index.html">page X</a></li>
<li><a href="../shortcodes/children/children-1/index.html">page 1</a></li>
<li><a href="../shortcodes/children/children-2/index.html">page 2</a></li>
<li><a href="../shortcodes/children/children-3/index.html">page 3</a></li>
</ul>
<h3 id="with-description">With Description</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">description</span><span class="p">=</span><span class="s">&#34;true&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<ul class="children children-li children-sort-">
<li><a href="../shortcodes/children/test/index.html">page X</a><p>This is a plain page test, and the beginning of a YAML multiline description...
</p></li>
<li><a href="../shortcodes/children/children-1/index.html">page 1</a><p>This is a demo child page</p></li>
<li><a href="../shortcodes/children/children-2/index.html">page 2</a><p>This is a demo child page with no description.
So its content is used as description.</p></li>
<li><a href="../shortcodes/children/children-3/index.html">page 3</a><p>This is a demo child page</p></li>
</ul>
<h3 id="infinite-depth-and-hidden-pages">Infinite Depth and Hidden Pages</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">depth</span><span class="p">=</span><span class="s">&#34;999&#34;</span> <span class="nx">showhidden</span><span class="p">=</span><span class="s">&#34;true&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<ul class="children children-li children-sort-">
<li><a href="../shortcodes/children/test/index.html">page X</a><ul>
</ul></li>
<li><a href="../shortcodes/children/children-1/index.html">page 1</a><ul>
<li><a href="../shortcodes/children/children-1/children-1-1/index.html">page 1-1</a><ul>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">page 1-1-1 (hidden)</a><ul>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html">page 1-1-1-1</a><ul>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html">page 1-1-1-1-1 (hidden)</a><ul>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html">page 1-1-1-1-1-1</a><ul>
</ul></li></ul></li></ul></li></ul></li>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">page 1-1-2</a><ul>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">page 1-1-2-1</a><ul>
</ul></li>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html">page 1-1-2-2</a><ul>
</ul></li></ul></li>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a><ul>
</ul></li></ul></li></ul></li>
<li><a href="../shortcodes/children/children-2/index.html">page 2</a><ul>
</ul></li>
<li><a href="../shortcodes/children/children-3/index.html">page 3</a><ul>
<li><a href="../shortcodes/children/children-3/test3/index.html">page 3-1</a><ul>
</ul></li></ul></li>
<li><a href="../shortcodes/children/children-4/index.html">page 4 (hidden)</a><ul>
</ul></li>
</ul>
<h3 id="heading-styles-for-container-and-elements">Heading Styles for Container and Elements</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">containerstyle</span><span class="p">=</span><span class="s">&#34;div&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;h2&#34;</span> <span class="nx">depth</span><span class="p">=</span><span class="s">&#34;3&#34;</span> <span class="nx">description</span><span class="p">=</span><span class="s">&#34;true&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="children children-h2 children-sort-">
<h2><a href="../shortcodes/children/test/index.html">page X</a></h2><p>This is a plain page test, and the beginning of a YAML multiline description...
</p>
<h2><a href="../shortcodes/children/children-1/index.html">page 1</a></h2><p>This is a demo child page</p>
<h3><a href="../shortcodes/children/children-1/children-1-1/index.html">page 1-1</a></h3><p>This is a demo child page</p>
<h4><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">page 1-1-2</a></h4><p>This is a demo child page</p>
<h4><a href="../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a></h4><p>This is a demo child page</p>
<h2><a href="../shortcodes/children/children-2/index.html">page 2</a></h2><p>This is a demo child page with no description.
So its content is used as description.</p>
<h2><a href="../shortcodes/children/children-3/index.html">page 3</a></h2><p>This is a demo child page</p>
<h3><a href="../shortcodes/children/children-3/test3/index.html">page 3-1</a></h3><p>This is a plain page test nested in a parent</p>
</div>
<h3 id="divs-for-group-and-element-styles">Divs for Group and Element Styles</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">containerstyle</span><span class="p">=</span><span class="s">&#34;div&#34;</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;div&#34;</span> <span class="nx">depth</span><span class="p">=</span><span class="s">&#34;3&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="children children-div children-sort-">
<div><a href="../shortcodes/children/test/index.html">page X</a></div>
<div><a href="../shortcodes/children/children-1/index.html">page 1</a></div>
<div><a href="../shortcodes/children/children-1/children-1-1/index.html">page 1-1</a></div>
<div><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">page 1-1-2</a></div>
<div><a href="../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a></div>
<div><a href="../shortcodes/children/children-2/index.html">page 2</a></div>
<div><a href="../shortcodes/children/children-3/index.html">page 3</a></div>
<div><a href="../shortcodes/children/children-3/test3/index.html">page 3-1</a></div>
</div>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsections of Children</h1>
<article class="default">
<h1>page X</h1>
<p>This is a plain demo child page.</p>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>page 1</h1>
<p>This is a demo child page.</p>
<h2 id="subpages-of-this-page">Subpages of this page</h2>
<ul class="children children-li children-sort-">
<li><a href="../shortcodes/children/children-1/children-1-1/index.html">page 1-1</a></li>
</ul>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsections of page 1</h1>
<article class="default">
<h1>page 1-1</h1>
<p>This is a demo child page with a hidden child. You can still access the hidden child <a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/">directly</a> or via the search.</p>
<h2 id="subpages-of-this-page">Subpages of this page</h2>
<ul class="children children-li children-sort-">
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">page 1-1-1 (hidden)</a></li>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">page 1-1-2</a></li>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a></li>
</ul>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsections of page 1-1</h1>
<article class="default">
<h1>page 1-1-2</h1>
<p>This is a plain demo child page.</p>
<h2 id="subpages-of-this-page">Subpages of this page</h2>
<ul class="children children-li children-sort-">
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">page 1-1-2-1</a></li>
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html">page 1-1-2-2</a></li>
</ul>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsections of page 1-1-2</h1>
<article class="default">
<h1>page 1-1-2-1</h1>
<p>This is a plain demo child page.</p>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>page 1-1-2-2</h1>
<p>This is a plain demo child page.</p>
<footer class="footline">
</footer>
</article>
</section>
<article class="default">
<h1>page 1-1-3</h1>
<p>This is a plain demo child page.</p>
<footer class="footline">
</footer>
</article>
</section>
</section>
<article class="default">
<h1>page 2</h1>
<p>This is a demo child page with no description.</p>
<p>So its content is used as description.</p>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>page 3</h1>
<p>This is a demo child page.</p>
<h2 id="subpages-of-this-page">Subpages of this page</h2>
<ul class="children children-li children-sort-">
<li><a href="../shortcodes/children/children-3/test3/index.html">page 3-1</a></li>
</ul>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsections of page 3</h1>
<article class="default">
<h1>page 3-1</h1>
<p>This is a plain demo child page.</p>
<footer class="footline">
</footer>
</article>
</section>
</section>
<article class="default">
<h1>Expand</h1>
<p>The <code>expand</code> shortcode displays an expandable/collapsible section of text.</p>
<div class="expand">
<a class="expand-label" onclick="$t=$(this); if($t.parent('.expand-expanded.expand-marked').length){ $t.next().css('display','none') }else if($t.parent('.expand-marked').length){ $t.next().css('display','block') }else{ $t.next('.expand-content').slideToggle(100); } $t.parent().toggleClass('expand-expanded');">
<i class="fas fa-chevron-down"></i>
<i class="fas fa-chevron-left expand-rtl direction-ltr"></i>
<i class="fas fa-chevron-right expand-ltr direction-ltr"></i>
Expand me...
</a>
<div class="expand-content" style="display: none;">
Thank you!
</div>
</div>
<h2 id="usage">Usage</h2>
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.</p>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="shortcode (positional)"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
><span>shortcode (positional)</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">&#34;Expand me...&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Thank</span> <span class="nx">you</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="shortcode (positional)" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="s">&#34;Expand me...&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Thank</span> <span class="nx">you</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/expand.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;title&#34;</span> <span class="s">&#34;Expand me...&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;content&#34;</span> <span class="s">&#34;Thank you!&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Position</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>title</strong></td>
<td style="text-align:left">1</td>
<td style="text-align:left"><code>&quot;Expand me...&quot;</code></td>
<td style="text-align:left">Arbitrary text to appear next to the expand/collapse icon.</td>
</tr>
<tr>
<td style="text-align:left"><strong>open</strong></td>
<td style="text-align:left">2</td>
<td style="text-align:left"><code>false</code></td>
<td style="text-align:left">When <code>true</code> the content text will be initially shown as expanded.</td>
</tr>
<tr>
<td style="text-align:left"><em><strong>&lt;content&gt;</strong></em></td>
<td style="text-align:left"></td>
<td style="text-align:left"><em>&lt;empty&gt;</em></td>
<td style="text-align:left">Arbitrary text to be displayed on expand.</td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<h3 id="all-defaults">All Defaults</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Yes</span><span class="p">,</span> <span class="nx">you</span> <span class="nx">did</span> <span class="nx">it</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="expand">
<a class="expand-label" onclick="$t=$(this); if($t.parent('.expand-expanded.expand-marked').length){ $t.next().css('display','none') }else if($t.parent('.expand-marked').length){ $t.next().css('display','block') }else{ $t.next('.expand-content').slideToggle(100); } $t.parent().toggleClass('expand-expanded');">
<i class="fas fa-chevron-down"></i>
<i class="fas fa-chevron-left expand-rtl direction-ltr"></i>
<i class="fas fa-chevron-right expand-ltr direction-ltr"></i>
Expand me...
</a>
<div class="expand-content" style="display: none;">
Yes, you did it!
</div>
</div>
<h3 id="initially-expanded">Initially Expanded</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">&#34;Expand me...&#34;</span> <span class="nx">open</span><span class="p">=</span><span class="s">&#34;true&#34;</span> <span class="o">%</span><span class="p">}}</span><span class="nx">No</span> <span class="nx">need</span> <span class="nx">to</span> <span class="nx">press</span> <span class="nx">you</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="expand expand-expanded">
<a class="expand-label" onclick="$t=$(this); if($t.parent('.expand-expanded.expand-marked').length){ $t.next().css('display','none') }else if($t.parent('.expand-marked').length){ $t.next().css('display','block') }else{ $t.next('.expand-content').slideToggle(100); } $t.parent().toggleClass('expand-expanded');">
<i class="fas fa-chevron-down"></i>
<i class="fas fa-chevron-left expand-rtl direction-ltr"></i>
<i class="fas fa-chevron-right expand-ltr direction-ltr"></i>
Expand me...
</a>
<div class="expand-content" style="display: block;">
No need to press you!
</div>
</div>
<h3 id="arbitrary-text">Arbitrary Text</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">&#34;Show me almost endless possibilities&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">You</span> <span class="nx">can</span> <span class="nx">add</span> <span class="nx">standard</span> <span class="nx">markdown</span> <span class="nx">syntax</span><span class="p">:</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">multiple</span> <span class="nx">paragraphs</span>
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">bullet</span> <span class="nx">point</span> <span class="nx">lists</span>
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">_emphasized_</span><span class="p">,</span> <span class="o">**</span><span class="nx">bold</span><span class="o">**</span> <span class="nx">and</span> <span class="nx">even</span> <span class="o">**</span><span class="nx">_bold</span> <span class="nx">emphasized_</span><span class="o">**</span> <span class="nx">text</span>
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="p">[</span><span class="nx">links</span><span class="p">](</span><span class="nx">https</span><span class="p">:</span><span class="c1">//example.com)
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="o">-</span> <span class="nx">etc</span><span class="p">.</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="s">```plaintext
</span></span></span><span class="line"><span class="cl"><span class="s">...and even source code
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="p">&gt;</span> <span class="nx">the</span> <span class="nx">possibilities</span> <span class="nx">are</span> <span class="nf">endless</span> <span class="p">(</span><span class="nx">almost</span> <span class="o">-</span> <span class="nx">including</span> <span class="nx">other</span> <span class="nx">shortcodes</span> <span class="nx">may</span> <span class="nx">or</span> <span class="nx">may</span> <span class="nx">not</span> <span class="nx">work</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="expand">
<a class="expand-label" onclick="$t=$(this); if($t.parent('.expand-expanded.expand-marked').length){ $t.next().css('display','none') }else if($t.parent('.expand-marked').length){ $t.next().css('display','block') }else{ $t.next('.expand-content').slideToggle(100); } $t.parent().toggleClass('expand-expanded');">
<i class="fas fa-chevron-down"></i>
<i class="fas fa-chevron-left expand-rtl direction-ltr"></i>
<i class="fas fa-chevron-right expand-ltr direction-ltr"></i>
Show me almost endless possibilities
</a>
<div class="expand-content" style="display: none;">
<p>You can add standard markdown syntax:</p>
<ul>
<li>multiple paragraphs</li>
<li>bullet point lists</li>
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
<li><a href="https://example.com">links</a></li>
<li>etc.</li>
</ul>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">...and even source code
</span></span></code></pre></div><blockquote>
<p>the possibilities are endless (almost - including other shortcodes may or may not work)</p>
</blockquote>
</div>
</div>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>Include</h1>
<p>The <code>include</code> shortcode includes other files from your project inside of the current page.</p>
<h2 id="usage">Usage</h2>
<p>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.</p>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="shortcode (positional)"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
><span>shortcode (positional)</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">include</span> <span class="nx">file</span><span class="p">=</span><span class="s">&#34;shortcodes/INCLUDE_ME.md&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="shortcode (positional)" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">include</span> <span class="s">&#34;shortcodes/INCLUDE_ME.md&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/include .html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;file&#34;</span> <span class="s">&#34;shortcodes/INCLUDE_ME.md&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<p>The included files can even contain Markdown and will be taken into account when generating the table of contents.</p>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Position</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>file</strong></td>
<td style="text-align:left">1</td>
<td style="text-align:left"><em>&lt;empty&gt;</em></td>
<td style="text-align:left">The path to the file to be included. Path resolution adheres to <a href="https://gohugo.io/functions/readfile/">Hugo&rsquo;s build-in <code>readFile</code> function</a></td>
</tr>
<tr>
<td style="text-align:left"><strong>hidefirstheading</strong></td>
<td style="text-align:left">2</td>
<td style="text-align:left"><code>false</code></td>
<td style="text-align:left">When <code>true</code> and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files.</td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<h3 id="arbitrary-content">Arbitrary Content</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">include</span> <span class="s">&#34;shortcodes/INCLUDE_ME.md&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div><p>You can add standard markdown syntax:</p>
<ul>
<li>multiple paragraphs</li>
<li>bullet point lists</li>
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
<li><a href="https://example.com">links</a></li>
<li>etc.</li>
</ul>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">...and even source code
</span></span></code></pre></div><blockquote>
<p>the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)</p>
</blockquote>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>Math</h1>
<p>The <code>math</code> shortcode generates beautiful formatted math and chemical formulae using the <a href="https://mathjax.org/">MathJax</a> library.</p>
<span class="math align-center">
$$\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)$$
</span>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>This only works in modern browsers.</p>
</div>
</div>
<h2 id="usage">Usage</h2>
<p>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.</p>
<p>You are free to also call this shortcode from your own partials.</p>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting (<a href="#configuration">see the configuration section</a>).</p>
</div>
</div>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="codefence"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','codefence')"
><span>codefence</span></button>
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="codefence" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">```math { align=&#34;center&#34; }
</span></span><span class="line"><span class="cl">$$\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)$$
</span></span><span class="line"><span class="cl">```
</span></span></code></pre></div>
</div>
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">math</span> <span class="nx">align</span><span class="p">=</span><span class="s">&#34;center&#34;</span> <span class="p">&gt;}}</span>
</span></span><span class="line"><span class="cl"><span class="err">$$\</span><span class="nf">left</span><span class="p">(</span> <span class="err">\</span><span class="nx">sum_</span><span class="p">{</span><span class="nx">k</span><span class="p">=</span><span class="mi">1</span><span class="p">}^</span><span class="nx">n</span> <span class="nx">a_k</span> <span class="nx">b_k</span> <span class="err">\</span><span class="nx">right</span><span class="p">)^</span><span class="mi">2</span> <span class="err">\</span><span class="nx">leq</span> <span class="err">\</span><span class="nf">left</span><span class="p">(</span> <span class="err">\</span><span class="nx">sum_</span><span class="p">{</span><span class="nx">k</span><span class="p">=</span><span class="mi">1</span><span class="p">}^</span><span class="nx">n</span> <span class="nx">a_k</span><span class="p">^</span><span class="mi">2</span> <span class="err">\</span><span class="nx">right</span><span class="p">)</span> <span class="err">\</span><span class="nf">left</span><span class="p">(</span> <span class="err">\</span><span class="nx">sum_</span><span class="p">{</span><span class="nx">k</span><span class="p">=</span><span class="mi">1</span><span class="p">}^</span><span class="nx">n</span> <span class="nx">b_k</span><span class="p">^</span><span class="mi">2</span> <span class="err">\</span><span class="nx">right</span><span class="p">)</span><span class="err">$$</span>
</span></span><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="o">/</span><span class="nx">math</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/math.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;content&#34;</span> <span class="s">&#34;$$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)$$&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;align&#34;</span> <span class="s">&#34;center&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>align</strong></td>
<td style="text-align:left"><code>center</code></td>
<td style="text-align:left">Allowed values are <code>left</code>, <code>center</code> or <code>right</code>.</td>
</tr>
<tr>
<td style="text-align:left"><em><strong>&lt;content&gt;</strong></em></td>
<td style="text-align:left"><em>&lt;empty&gt;</em></td>
<td style="text-align:left">Your formuale.</td>
</tr>
</tbody>
</table>
<h2 id="configuration">Configuration</h2>
<p>MathJax is configured with default settings. You can customize MathJax&rsquo;s default settings for all of your files thru a JSON object in your <code>config.toml</code> or override these settings per page thru your pages frontmatter.</p>
<p>The JSON object of your <code>config.toml</code> / frontmatter is forwarded into MathJax&rsquo;s configuration object.</p>
<p>See <a href="https://docs.mathjax.org/en/latest/options/index.html">MathJax documentation</a> for all allowed settings.</p>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting.</p>
</div>
</div>
<h3 id="global-configuration-file">Global Configuration File</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">params</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s2">&#34;{ \&#34;chtml\&#34;: { \&#34;displayAlign\&#34;: \&#34;left\&#34; } }&#34;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">markup</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span class="nx">highlight</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="c"># if `guessSyntax = true`, there will be no unstyled code even if no language</span>
</span></span><span class="line"><span class="cl"> <span class="c"># was given BUT Mermaid and Math codefences will not work anymore! So this is a</span>
</span></span><span class="line"><span class="cl"> <span class="c"># mandatory setting for your site if you want to use Math codefences</span>
</span></span><span class="line"><span class="cl"> <span class="nx">guessSyntax</span> <span class="p">=</span> <span class="kc">false</span>
</span></span></code></pre></div><h3 id="pages-frontmatter">Page&rsquo;s Frontmatter</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="err">+++</span>
</span></span><span class="line"><span class="cl"><span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s2">&#34;{ \&#34;chtml\&#34;: { \&#34;displayAlign\&#34;: \&#34;left\&#34; } }&#34;</span>
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
</span></span></code></pre></div><h2 id="examples">Examples</h2>
<h3 id="inline-math">Inline Math</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Inline math is generated if you use a single <span class="sb">`$`</span> as a delimiter around your formulae: {{<span class="p">&lt;</span> <span class="nt">math</span> <span class="p">&gt;</span>}}$\sqrt{3}${{<span class="p">&lt;</span> <span class="p">/</span><span class="nt">math</span> <span class="p">&gt;</span>}}
</span></span></code></pre></div><p>Inline math is generated if you use a single <code>$</code> as a delimiter around your formulae:
<span class="math align-center">$\sqrt{3}$</span></p>
<h3 id="blocklevel-math-with-right-alignment">Blocklevel Math with Right Alignment</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">If you delimit your formulae by two consecutive <span class="sb">`$$`</span> it generates a new block.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">{{<span class="p">&lt;</span> <span class="nt">math</span> <span class="na">align</span><span class="o">=</span><span class="s">&#34;right&#34;</span> <span class="p">&gt;</span>}}
</span></span><span class="line"><span class="cl">$$\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)$$
</span></span><span class="line"><span class="cl">{{<span class="p">&lt;</span> <span class="p">/</span><span class="nt">math</span> <span class="p">&gt;</span>}}
</span></span></code></pre></div><p>If you delimit your formulae by two consecutive <code>$$</code> it generates a new block.</p>
<span class="math align-right">
$$\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)$$
</span>
<h3 id="codefence">Codefence</h3>
<p>You can also use codefences but without further parameter.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```math
</span></span></span><span class="line"><span class="cl"><span class="s"></span>$$\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)$$
</span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span></code></pre></div>
<span class="math align-center">$$\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)$$</span><h3 id="chemical-formulae">Chemical Formulae</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">{{<span class="p">&lt;</span> <span class="nt">math</span> <span class="p">&gt;</span>}}
</span></span><span class="line"><span class="cl">$$\ce{Hg^2+ -&gt;[I-] HgI2 -&gt;[I-] [Hg^{II}I4]^2-}$$
</span></span><span class="line"><span class="cl">{{<span class="p">&lt;</span> <span class="p">/</span><span class="nt">math</span> <span class="p">&gt;</span>}}
</span></span></code></pre></div>
<span class="math align-center">
$$\ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-}$$
</span>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>Mermaid</h1>
<p>The <code>mermaid</code> shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the <a href="https://mermaidjs.github.io/">Mermaid</a> library.</p>
<div class="mermaid align-center">
graph LR;
If --&gt; Then
Then --&gt; Else
</div>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>This only works in modern browsers.</p>
</div>
</div>
<div class="box notices cstyle warning">
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Warning</div>
<div class="box-content">
<p>Due to limitations with <a href="https://github.com/mermaid-js/mermaid/issues/1846">Mermaid</a>, it is currently not possible to use Mermaid code fences in an initially collapsed <code>expand</code> shortcode. This is a know issue and <a href="https://github.com/McShelby/hugo-theme-relearn/issues/187">can&rsquo;t be fixed by this theme</a>.</p>
</div>
</div>
<h2 id="usage">Usage</h2>
<p>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 Mermaid codefences (eg. GitHub) and so your markdown becomes more portable.</p>
<p>You are free to also call this shortcode from your own partials.</p>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting (<a href="#configuration">see the configuration section</a>).</p>
</div>
</div>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="codefence"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','codefence')"
><span>codefence</span></button>
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="codefence" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">```mermaid { align=&#34;center&#34; }
</span></span><span class="line"><span class="cl">graph LR;
</span></span><span class="line"><span class="cl"> If --&gt; Then
</span></span><span class="line"><span class="cl"> Then --&gt; Else
</span></span><span class="line"><span class="cl">```
</span></span></code></pre></div>
</div>
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">mermaid</span> <span class="nx">align</span><span class="p">=</span><span class="s">&#34;center&#34;</span> <span class="p">&gt;}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">graph</span> <span class="nx">LR</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="nx">If</span> <span class="o">--</span><span class="p">&gt;</span> <span class="nx">Then</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Then</span> <span class="o">--</span><span class="p">&gt;</span> <span class="nx">Else</span>
</span></span><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/mermaid.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;content&#34;</span> <span class="s">&#34;graph LR;\nIf --&gt; Then\nThen --&gt; Else&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;align&#34;</span> <span class="s">&#34;center&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<p>The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.</p>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>align</strong></td>
<td style="text-align:left"><code>center</code></td>
<td style="text-align:left">Allowed values are <code>left</code>, <code>center</code> or <code>right</code>.</td>
</tr>
<tr>
<td style="text-align:left"><em><strong>&lt;content&gt;</strong></em></td>
<td style="text-align:left"><em>&lt;empty&gt;</em></td>
<td style="text-align:left">Your Mermaid graph.</td>
</tr>
</tbody>
</table>
<h2 id="configuration">Configuration</h2>
<p>Mermaid is configured with default settings. You can customize Mermaid&rsquo;s default settings for all of your files thru a JSON object in your <code>config.toml</code>, override these settings per page thru your pages frontmatter or override these setting per diagramm thru <a href="https://mermaid-js.github.io/mermaid/#/directives?id=directives">diagram directives</a>.</p>
<p>The JSON object of your <code>config.toml</code> / frontmatter is forwarded into Mermaid&rsquo;s <code>mermaid.initialize()</code> function.</p>
<p>See <a href="http://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults">Mermaid documentation</a> for all allowed settings.</p>
<p>The <code>theme</code> setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in <code>config.toml</code>, frontmatter or diagram directives.</p>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting.</p>
</div>
</div>
<h3 id="global-configuration-file">Global Configuration File</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">params</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s2">&#34;{ \&#34;theme\&#34;: \&#34;dark\&#34; }&#34;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">markup</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span class="nx">highlight</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="c"># if `guessSyntax = true`, there will be no unstyled code even if no language</span>
</span></span><span class="line"><span class="cl"> <span class="c"># was given BUT Mermaid and Math codefences will not work anymore! So this is a</span>
</span></span><span class="line"><span class="cl"> <span class="c"># mandatory setting for your site if you want to use Mermaid codefences</span>
</span></span><span class="line"><span class="cl"> <span class="nx">guessSyntax</span> <span class="p">=</span> <span class="kc">false</span>
</span></span></code></pre></div><h3 id="pages-frontmatter">Page&rsquo;s Frontmatter</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="err">+++</span>
</span></span><span class="line"><span class="cl"><span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s2">&#34;{ \&#34;theme\&#34;: \&#34;dark\&#34; }&#34;</span>
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
</span></span></code></pre></div><h2 id="examples">Examples</h2>
<h3 id="flowchart-with-non-default-mermaid-theme">Flowchart with Non-Default Mermaid Theme</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">mermaid</span> <span class="p">&gt;}}</span>
</span></span><span class="line"><span class="cl"><span class="o">%%</span><span class="p">{</span><span class="nx">init</span><span class="p">:{</span><span class="s">&#34;theme&#34;</span><span class="p">:</span><span class="s">&#34;forest&#34;</span><span class="p">}}</span><span class="o">%%</span>
</span></span><span class="line"><span class="cl"><span class="nx">graph</span> <span class="nx">LR</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="nx">A</span><span class="p">[</span><span class="nx">Hard</span> <span class="nx">edge</span><span class="p">]</span> <span class="o">--</span><span class="p">&gt;|</span><span class="nx">Link</span> <span class="nx">text</span><span class="p">|</span> <span class="nf">B</span><span class="p">(</span><span class="nx">Round</span> <span class="nx">edge</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="nx">B</span> <span class="o">--</span><span class="p">&gt;</span> <span class="nx">C</span><span class="p">{&lt;</span><span class="nx">strong</span><span class="p">&gt;</span><span class="nx">Decision</span><span class="p">&lt;</span><span class="o">/</span><span class="nx">strong</span><span class="p">&gt;}</span>
</span></span><span class="line"><span class="cl"> <span class="nx">C</span> <span class="o">--</span><span class="p">&gt;|</span><span class="nx">One</span><span class="p">|</span> <span class="nx">D</span><span class="p">[</span><span class="nx">Result</span> <span class="nx">one</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="nx">C</span> <span class="o">--</span><span class="p">&gt;|</span><span class="nx">Two</span><span class="p">|</span> <span class="nx">E</span><span class="p">[</span><span class="nx">Result</span> <span class="nx">two</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
<div class="mermaid align-center">
%%{init:{&#34;theme&#34;:&#34;forest&#34;}}%%
graph LR;
A[Hard edge] --&gt;|Link text| B(Round edge)
B --&gt; C{&lt;strong&gt;Decision&lt;/strong&gt;}
C --&gt;|One| D[Result one]
C --&gt;|Two| E[Result two]
</div>
<h3 id="sequence">Sequence</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">mermaid</span> <span class="p">&gt;}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">sequenceDiagram</span>
</span></span><span class="line"><span class="cl"> <span class="nx">participant</span> <span class="nx">Alice</span>
</span></span><span class="line"><span class="cl"> <span class="nx">participant</span> <span class="nx">Bob</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Alice</span><span class="o">-&gt;&gt;</span><span class="nx">John</span><span class="p">:</span> <span class="nx">Hello</span> <span class="nx">John</span><span class="p">,</span> <span class="nx">how</span> <span class="nx">are</span> <span class="nx">you</span><span class="err">?</span>
</span></span><span class="line"><span class="cl"> <span class="nx">loop</span> <span class="nx">Healthcheck</span>
</span></span><span class="line"><span class="cl"> <span class="nx">John</span><span class="o">-</span><span class="p">&gt;</span><span class="nx">John</span><span class="p">:</span> <span class="nx">Fight</span> <span class="nx">against</span> <span class="nx">hypochondria</span>
</span></span><span class="line"><span class="cl"> <span class="nx">end</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Note</span> <span class="nx">right</span> <span class="nx">of</span> <span class="nx">John</span><span class="p">:</span> <span class="nx">Rational</span> <span class="nx">thoughts</span> <span class="p">&lt;</span><span class="nx">br</span><span class="p">&gt;</span><span class="nx">prevail</span><span class="o">...</span>
</span></span><span class="line"><span class="cl"> <span class="nx">John</span><span class="o">--</span><span class="p">&gt;</span><span class="nx">Alice</span><span class="p">:</span> <span class="nx">Great</span><span class="p">!</span>
</span></span><span class="line"><span class="cl"> <span class="nx">John</span><span class="o">-</span><span class="p">&gt;</span><span class="nx">Bob</span><span class="p">:</span> <span class="nx">How</span> <span class="nx">about</span> <span class="nx">you</span><span class="err">?</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Bob</span><span class="o">--</span><span class="p">&gt;</span><span class="nx">John</span><span class="p">:</span> <span class="nx">Jolly</span> <span class="nx">good</span><span class="p">!</span>
</span></span><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
<div class="mermaid align-center">
sequenceDiagram
participant Alice
participant Bob
Alice-&gt;&gt;John: Hello John, how are you?
loop Healthcheck
John-&gt;John: Fight against hypochondria
end
Note right of John: Rational thoughts &lt;br&gt;prevail...
John--&gt;Alice: Great!
John-&gt;Bob: How about you?
Bob--&gt;John: Jolly good!
</div>
<h3 id="gantt">GANTT</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">mermaid</span> <span class="p">&gt;}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">gantt</span>
</span></span><span class="line"><span class="cl"> <span class="nx">dateFormat</span> <span class="nx">YYYY</span><span class="o">-</span><span class="nx">MM</span><span class="o">-</span><span class="nx">DD</span>
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="nx">Adding</span> <span class="nx">GANTT</span> <span class="nx">diagram</span> <span class="nx">functionality</span> <span class="nx">to</span> <span class="nx">Mermaid</span>
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="nx">A</span> <span class="nx">section</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Completed</span> <span class="nx">task</span> <span class="p">:</span><span class="nx">done</span><span class="p">,</span> <span class="nx">des1</span><span class="p">,</span> <span class="mi">2014</span><span class="o">-</span><span class="mo">01</span><span class="o">-</span><span class="mo">06</span><span class="p">,</span><span class="mi">2014</span><span class="o">-</span><span class="mo">01</span><span class="o">-</span><span class="mi">08</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Active</span> <span class="nx">task</span> <span class="p">:</span><span class="nx">active</span><span class="p">,</span> <span class="nx">des2</span><span class="p">,</span> <span class="mi">2014</span><span class="o">-</span><span class="mo">01</span><span class="o">-</span><span class="mi">09</span><span class="p">,</span> <span class="mi">3</span><span class="nx">d</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Future</span> <span class="nx">task</span> <span class="p">:</span> <span class="nx">des3</span><span class="p">,</span> <span class="nx">after</span> <span class="nx">des2</span><span class="p">,</span> <span class="mi">5</span><span class="nx">d</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Future</span> <span class="nx">task2</span> <span class="p">:</span> <span class="nx">des4</span><span class="p">,</span> <span class="nx">after</span> <span class="nx">des3</span><span class="p">,</span> <span class="mi">5</span><span class="nx">d</span>
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="nx">Critical</span> <span class="nx">tasks</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Completed</span> <span class="nx">task</span> <span class="nx">in</span> <span class="nx">the</span> <span class="nx">critical</span> <span class="nx">line</span> <span class="p">:</span><span class="nx">crit</span><span class="p">,</span> <span class="nx">done</span><span class="p">,</span> <span class="mi">2014</span><span class="o">-</span><span class="mo">01</span><span class="o">-</span><span class="mo">06</span><span class="p">,</span><span class="mi">24</span><span class="nx">h</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Implement</span> <span class="nx">parser</span> <span class="nx">and</span> <span class="nx">jison</span> <span class="p">:</span><span class="nx">crit</span><span class="p">,</span> <span class="nx">done</span><span class="p">,</span> <span class="nx">after</span> <span class="nx">des1</span><span class="p">,</span> <span class="mi">2</span><span class="nx">d</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Create</span> <span class="nx">tests</span> <span class="k">for</span> <span class="nx">parser</span> <span class="p">:</span><span class="nx">crit</span><span class="p">,</span> <span class="nx">active</span><span class="p">,</span> <span class="mi">3</span><span class="nx">d</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Future</span> <span class="nx">task</span> <span class="nx">in</span> <span class="nx">critical</span> <span class="nx">line</span> <span class="p">:</span><span class="nx">crit</span><span class="p">,</span> <span class="mi">5</span><span class="nx">d</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Create</span> <span class="nx">tests</span> <span class="k">for</span> <span class="nx">renderer</span> <span class="p">:</span><span class="mi">2</span><span class="nx">d</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Add</span> <span class="nx">to</span> <span class="nx">Mermaid</span> <span class="p">:</span><span class="mi">1</span><span class="nx">d</span>
</span></span><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
<div class="mermaid align-center">
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to Mermaid
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d
section Critical tasks
Completed task in the critical line :crit, done, 2014-01-06,24h
Implement parser and jison :crit, done, after des1, 2d
Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d
Create tests for renderer :2d
Add to Mermaid :1d
</div>
<h3 id="class-diagram-aligned-to-the-right">Class Diagram Aligned to the Right</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">mermaid</span> <span class="nx">align</span><span class="p">=</span><span class="s">&#34;right&#34;</span> <span class="p">&gt;}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">classDiagram</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class01</span> <span class="p">&lt;|</span><span class="o">--</span> <span class="nx">AveryLongClass</span> <span class="p">:</span> <span class="nx">Cool</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class03</span> <span class="o">*--</span> <span class="nx">Class04</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class05</span> <span class="nx">o</span><span class="o">--</span> <span class="nx">Class06</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class07</span> <span class="p">..</span> <span class="nx">Class08</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class09</span> <span class="o">--</span><span class="p">&gt;</span> <span class="nx">C2</span> <span class="p">:</span> <span class="nx">Where</span> <span class="nx">am</span> <span class="nx">i</span><span class="err">?</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class09</span> <span class="o">--*</span> <span class="nx">C3</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class09</span> <span class="o">--</span><span class="p">|&gt;</span> <span class="nx">Class07</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class07</span> <span class="p">:</span> <span class="nf">equals</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class07</span> <span class="p">:</span> <span class="nx">Object</span><span class="p">[]</span> <span class="nx">elementData</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class01</span> <span class="p">:</span> <span class="nf">size</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class01</span> <span class="p">:</span> <span class="kt">int</span> <span class="nx">chimp</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class01</span> <span class="p">:</span> <span class="kt">int</span> <span class="nx">gorilla</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Class08</span> <span class="o">&lt;--</span><span class="p">&gt;</span> <span class="nx">C2</span><span class="p">:</span> <span class="nx">Cool</span> <span class="nx">label</span>
</span></span><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
<div class="mermaid align-right">
classDiagram
Class01 &lt;|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --&gt; C2 : Where am i?
Class09 --* C3
Class09 --|&gt; Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 &lt;--&gt; C2: Cool label
</div>
<h3 id="state-diagram-with-codefence-syntax">State Diagram with Codefence Syntax</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="s">```mermaid
</span></span></span><span class="line"><span class="cl"><span class="s">stateDiagram-v2
</span></span></span><span class="line"><span class="cl"><span class="s"> open: Open Door
</span></span></span><span class="line"><span class="cl"><span class="s"> closed: Closed Door
</span></span></span><span class="line"><span class="cl"><span class="s"> locked: Locked Door
</span></span></span><span class="line"><span class="cl"><span class="s"> open --&gt; closed: Close
</span></span></span><span class="line"><span class="cl"><span class="s"> closed --&gt; locked: Lock
</span></span></span><span class="line"><span class="cl"><span class="s"> locked --&gt; closed: Unlock
</span></span></span><span class="line"><span class="cl"><span class="s"> closed --&gt; open: Open
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span></code></pre></div>
<div class="mermaid align-center">stateDiagram-v2
open: Open Door
closed: Closed Door
locked: Locked Door
open --&gt; closed: Close
closed --&gt; locked: Lock
locked --&gt; closed: Unlock
closed --&gt; open: Open</div>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>Notice</h1>
<p>The <code>notice</code> shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page.</p>
<div class="box notices cstyle primary">
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> There may be pirates</div>
<div class="box-content">
<p>It is all about the boxes.</p>
</div>
</div>
<h2 id="usage">Usage</h2>
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.</p>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="shortcode (positional)"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
><span>shortcode (positional)</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;primary&#34;</span> <span class="nx">title</span><span class="p">=</span><span class="s">&#34;There may be pirates&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;skull-crossbones&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">It</span> <span class="nx">is</span> <span class="nx">all</span> <span class="nx">about</span> <span class="nx">the</span> <span class="nx">boxes</span><span class="p">.</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="shortcode (positional)" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">primary</span> <span class="s">&#34;There may be pirates&#34;</span> <span class="s">&#34;skull-crossbones&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">It</span> <span class="nx">is</span> <span class="nx">all</span> <span class="nx">about</span> <span class="nx">the</span> <span class="nx">boxes</span><span class="p">.</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/notice.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;style&#34;</span> <span class="s">&#34;primary&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;title&#34;</span> <span class="s">&#34;There may be pirates&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;icon&#34;</span> <span class="s">&#34;skull-crossbones&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;content&#34;</span> <span class="s">&#34;It is all about the boxes.&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Position</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>style</strong></td>
<td style="text-align:left">1</td>
<td style="text-align:left"><code>default</code></td>
<td style="text-align:left">The color scheme used to highlight the box content.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code></td>
</tr>
<tr>
<td style="text-align:left"><strong>title</strong></td>
<td style="text-align:left">2</td>
<td style="text-align:left">see notes</td>
<td style="text-align:left">Arbitrary text for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: <em>&lt;empty&gt;</em><br><br>If you want no title for a severity style, you have to set this parameter to <code>&quot; &quot;</code> (a non empty string filled with spaces)</td>
</tr>
<tr>
<td style="text-align:left"><strong>icon</strong></td>
<td style="text-align:left">3</td>
<td style="text-align:left">see notes</td>
<td style="text-align:left"><a href="../cont/icons/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other colors: <em>&lt;empty&gt;</em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>&quot; &quot;</code> (a non empty string filled with spaces)</td>
</tr>
<tr>
<td style="text-align:left"><em><strong>&lt;content&gt;</strong></em></td>
<td style="text-align:left"></td>
<td style="text-align:left"><em>&lt;empty&gt;</em></td>
<td style="text-align:left">Arbitrary text to be displayed in box.</td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<h3 id="by-severity">By Severity</h3>
<h4 id="info-with-markup">Info with markup</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;info&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">An</span> <span class="o">**</span><span class="nx">information</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">You</span> <span class="nx">can</span> <span class="nx">add</span> <span class="nx">standard</span> <span class="nx">markdown</span> <span class="nx">syntax</span><span class="p">:</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">multiple</span> <span class="nx">paragraphs</span>
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">bullet</span> <span class="nx">point</span> <span class="nx">lists</span>
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">_emphasized_</span><span class="p">,</span> <span class="o">**</span><span class="nx">bold</span><span class="o">**</span> <span class="nx">and</span> <span class="nx">even</span> <span class="o">***</span><span class="nx">bold</span> <span class="nx">emphasized</span><span class="o">***</span> <span class="nx">text</span>
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="p">[</span><span class="nx">links</span><span class="p">](</span><span class="nx">https</span><span class="p">:</span><span class="c1">//example.com)
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="o">-</span> <span class="nx">etc</span><span class="p">.</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="s">```plaintext
</span></span></span><span class="line"><span class="cl"><span class="s">...and even source code
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="p">&gt;</span> <span class="nx">the</span> <span class="nx">possibilities</span> <span class="nx">are</span> <span class="nf">endless</span> <span class="p">(</span><span class="nx">almost</span> <span class="o">-</span> <span class="nx">including</span> <span class="nx">other</span> <span class="nx">shortcodes</span> <span class="nx">may</span> <span class="nx">or</span> <span class="nx">may</span> <span class="nx">not</span> <span class="nx">work</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle info">
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
<div class="box-content">
<p>An <strong>information</strong> disclaimer</p>
<p>You can add standard markdown syntax:</p>
<ul>
<li>multiple paragraphs</li>
<li>bullet point lists</li>
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
<li><a href="https://example.com">links</a></li>
<li>etc.</li>
</ul>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">...and even source code
</span></span></code></pre></div><blockquote>
<p>the possibilities are endless (almost - including other shortcodes may or may not work)</p>
</blockquote>
</div>
</div>
<h4 id="note">Note</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;note&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">notice</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>A <strong>notice</strong> disclaimer</p>
</div>
</div>
<h4 id="tip">Tip</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;tip&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">tip</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span></code></pre></div>
<div class="box notices cstyle tip">
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
<div class="box-content">
<p>A <strong>tip</strong> disclaimer</p>
</div>
</div>
<h4 id="warning">Warning</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;warning&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">warning</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle warning">
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Warning</div>
<div class="box-content">
<p>A <strong>warning</strong> disclaimer</p>
</div>
</div>
<h4 id="warning-with-non-default-title-and-icon">Warning with Non-Default Title and Icon</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;warning&#34;</span> <span class="nx">title</span><span class="p">=</span><span class="s">&#34;Here are dragons&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;dragon&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">warning</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle warning">
<div class="box-label"><i class="fa-fw fas fa-dragon"></i> Here are dragons</div>
<div class="box-content">
<p>A <strong>warning</strong> disclaimer</p>
</div>
</div>
<h4 id="warning-without-a-title-and-icon">Warning without a Title and Icon</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;warning&#34;</span> <span class="nx">title</span><span class="p">=</span><span class="s">&#34; &#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34; &#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">warning</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle warning">
<div class="box-label"> </div>
<div class="box-content">
<p>A <strong>warning</strong> disclaimer</p>
</div>
</div>
<h3 id="by-brand-colors">By Brand Colors</h3>
<h4 id="primary-with-title-only">Primary with Title only</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;primary&#34;</span> <span class="nx">title</span><span class="p">=</span><span class="s">&#34;Primary&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">primary</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle primary">
<div class="box-label">Primary</div>
<div class="box-content">
<p>A <strong>primary</strong> disclaimer</p>
</div>
</div>
<h4 id="secondary-with-icon-only">Secondary with Icon only</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;secondary&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;stopwatch&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">secondary</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle secondary">
<div class="box-label"><i class="fa-fw fas fa-stopwatch"></i> </div>
<div class="box-content">
<p>A <strong>secondary</strong> disclaimer</p>
</div>
</div>
<h3 id="by-color">By Color</h3>
<h4 id="blue-without-a-title-and-icon">Blue without a Title and Icon</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;blue&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">blue</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle blue">
<div class="box-label"></div>
<div class="box-content">
<p>A <strong>blue</strong> disclaimer</p>
</div>
</div>
<h4 id="green-with-title-only">Green with Title only</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;green&#34;</span> <span class="nx">title</span><span class="p">=</span><span class="s">&#34;Green&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">green</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle green">
<div class="box-label">Green</div>
<div class="box-content">
<p>A <strong>green</strong> disclaimer</p>
</div>
</div>
<h4 id="grey-with-icon-only">Grey with Icon only</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;grey&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;bug&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">grey</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle grey">
<div class="box-label"><i class="fa-fw fas fa-bug"></i> </div>
<div class="box-content">
<p>A <strong>grey</strong> disclaimer</p>
</div>
</div>
<h4 id="orange-with-title-and-icon">Orange with Title and Icon</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;orange&#34;</span> <span class="nx">title</span><span class="p">=</span><span class="s">&#34;Orange&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;bug&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">orange</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle orange">
<div class="box-label"><i class="fa-fw fas fa-bug"></i> Orange</div>
<div class="box-content">
<p>A <strong>orange</strong> disclaimer</p>
</div>
</div>
<h4 id="red">Red</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;red&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">red</span><span class="o">**</span> <span class="nx">disclaimer</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle red">
<div class="box-label"></div>
<div class="box-content">
<p>A <strong>red</strong> disclaimer</p>
</div>
</div>
<h3 id="by-special-color">By Special Color</h3>
<h4 id="default-with-title-and-icon">Default with Title and Icon</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;default&#34;</span> <span class="nx">title</span><span class="s">&#34;Pay Attention to this Note!&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;skull-crossbones&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">Some</span> <span class="nx">serious</span> <span class="nx">information</span><span class="p">.</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle default">
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Pay Attention to this Note!</div>
<div class="box-content">
<p>Some serious information.</p>
</div>
</div>
<h4 id="transparent-with-title-and-icon">Transparent with Title and Icon</h4>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">&#34;transparent&#34;</span> <span class="nx">title</span><span class="s">&#34;Pay Attention to this Note!&#34;</span> <span class="nx">icon</span><span class="p">=</span><span class="s">&#34;skull-crossbones&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="nx">Some</span> <span class="nx">serious</span> <span class="nx">information</span><span class="p">.</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
<div class="box notices cstyle transparent">
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Pay Attention to this Note!</div>
<div class="box-content">
<p>Some serious information.</p>
</div>
</div>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>Site param</h1>
<p>The <code>siteparam</code> shortcode prints values of site params.</p>
<h2 id="usage">Usage</h2>
<p>While the examples are using shortcodes with named parameter you are free to use positional aswell or call this shortcode from your own partials.</p>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="shortcode (positional)"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
><span>shortcode (positional)</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="nx">name</span><span class="p">=</span><span class="s">&#34;editURL&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="shortcode (positional)" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="s">&#34;editURL&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/siteparam.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;name&#34;</span> <span class="s">&#34;editURL&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Position</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>name</strong></td>
<td style="text-align:left">1</td>
<td style="text-align:left"><em>&lt;empty&gt;</em></td>
<td style="text-align:left">The name of the site param to be displayed.</td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<h3 id="editurl-from-configtoml"><code>editURL</code> from <code>config.toml</code></h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="s">`editURL`</span> <span class="nx">value</span><span class="p">:</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="nx">name</span><span class="p">=</span><span class="s">&#34;editURL&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span></code></pre></div><p><code>editURL</code> value: <a href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/">https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/</a></p>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>Swagger</h1>
<p>This shortcode uses the <a href="https://mrin9.github.io/RapiDoc">RapiDoc</a> library to display your Swagger / OpenAPI Specifications.</p>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>This only works in modern browsers.</p>
</div>
</div>
<h2 id="usage">Usage</h2>
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">swagger</span> <span class="nx">src</span><span class="p">=</span><span class="s">&#34;https://petstore3.swagger.io/api/v3/openapi.json&#34;</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/swagger.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;src&#34;</span> <span class="s">&#34;https://petstore3.swagger.io/api/v3/openapi.json&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>src</strong></td>
<td style="text-align:left"><em>&lt;empty&gt;</em></td>
<td style="text-align:left">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.</td>
</tr>
</tbody>
</table>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>If you want to print out (or generate a PDF) from your Swagger documentation, don&rsquo;t initiate printing directly from the page because the elements are optimized for interactive usage in a browser.</p>
<p>Instead, open the <a href="../basics/configuration/#activate-print-support">print preview</a> in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.</p>
</div>
</div>
<h2 id="configuration">Configuration</h2>
<p>Swagger is configured with default settings. You can customize Swagger&rsquo;s default settings for all of your files thru a JSON object in your <code>config.toml</code> or override these settings per page thru your pages frontmatter.</p>
<p>The JSON object of your <code>config.toml</code> / frontmatter is forwarded into Swagger&rsquo;s initialization. At the moment, only the <code>theme</code> setting is supported.</p>
<p>The <code>theme</code> setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in <code>config.toml</code> or frontmatter.</p>
<h3 id="global-configuration-file">Global Configuration File</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">params</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="nx">swaggerInitialize</span> <span class="p">=</span> <span class="s2">&#34;{ \&#34;theme\&#34;: \&#34;dark\&#34; }&#34;</span>
</span></span></code></pre></div><h2 id="example">Example</h2>
<h3 id="using-local-file">Using Local File</h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">swagger</span> <span class="nx">src</span><span class="p">=</span><span class="s">&#34;petstore.json&#34;</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
<rapi-doc
allow-spec-file-download="false"
allow-server-selection="false"
allow-try="false"
font-size="default"
render-style="read"
default-schema-tab="example"
layout="column"
load-fonts="false"
schema-description-expanded="true"
schema-style="table"
show-header="false"
spec-url="../shortcodes/swagger/petstore.json"
sort-tags="true"
></rapi-doc>
<footer class="footline">
</footer>
</article>
<article class="default">
<h1>Tabbed views</h1>
<p>The <code>tabs</code> 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.</p>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="python"
data-tab-group="tabs-example-language"
class="tab-nav-button direction-ltr active"
onclick="switchTab('tabs-example-language','python')"
><span>python</span></button>
<button
data-tab-item="bash"
data-tab-group="tabs-example-language"
class="tab-nav-button direction-ltr "
onclick="switchTab('tabs-example-language','bash')"
><span>bash</span></button>
</div>
<div class="tab-content">
<div data-tab-item="python" data-tab-group="tabs-example-language" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">&#34;Hello World!&#34;</span><span class="p">)</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="bash" data-tab-group="tabs-example-language" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl"><span class="nb">echo</span> <span class="s2">&#34;Hello World!&#34;</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<h2 id="usage">Usage</h2>
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr active"
onclick="switchTab('shortcode-parameter','shortcode')"
><span>shortcode</span></button>
<button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
class="tab-nav-button direction-ltr "
onclick="switchTab('shortcode-parameter','partial')"
><span>partial</span></button>
</div>
<div class="tab-content">
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">tabs</span> <span class="p">&gt;}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">name</span><span class="p">=</span><span class="s">&#34;python&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="s">```python
</span></span></span><span class="line"><span class="cl"><span class="s">print(&#34;Hello World!&#34;)
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">name</span><span class="p">=</span><span class="s">&#34;bash&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="s">```bash
</span></span></span><span class="line"><span class="cl"><span class="s">echo &#34;Hello World!&#34;
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">&#34;shortcodes/tabs.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;context&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;tabs&#34;</span> <span class="p">(</span><span class="nf">slice</span>
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;name&#34;</span> <span class="s">&#34;python&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;content&#34;</span> <span class="p">(</span><span class="s">&#34;```python\nprint(\&#34;Hello World!\&#34;)\n```&#34;</span> <span class="p">|</span> <span class="nx">markdownify</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;name&#34;</span> <span class="s">&#34;bash&#34;</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;content&#34;</span> <span class="p">(</span><span class="s">&#34;```bash\necho \&#34;Hello World!\&#34;\n```&#34;</span> <span class="p">|</span> <span class="nx">markdownify</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th style="text-align:left">Name</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><strong>groupid</strong></td>
<td style="text-align:left"><code>default</code></td>
<td style="text-align:left">Arbitrary name of the group the tab view belongs to.<br><br>Tab views with the same <strong>groupid</strong> sychronize their selected tab. This sychronization applies to the whole site!</td>
</tr>
<tr>
<td style="text-align:left"><em><strong>&lt;content&gt;</strong></em></td>
<td style="text-align:left"><em>&lt;empty&gt;</em></td>
<td style="text-align:left">Arbitrary number of tabs defined with the <code>tab</code> sub-shortcode.</td>
</tr>
</tbody>
</table>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
<div class="box-content">
<p>When using tab views with different content sets, make sure to use a common <code>groupid</code> for equal sets of tabs but distinct <code>groupid</code> for different sets.</p>
<p>The tab selection is restored automatically based on the <code>groupid</code> and if it cannot find a tab item because it came from the <code>'default'</code> group on a different page then the first tab is selected instead.</p>
</div>
</div>
<h2 id="examples">Examples</h2>
<h3 id="distinct-groupid">Distinct <code>groupid</code></h3>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">tabs</span> <span class="nx">groupid</span><span class="p">=</span><span class="s">&#34;config&#34;</span> <span class="p">&gt;}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">name</span><span class="p">=</span><span class="s">&#34;json&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="s">```json
</span></span></span><span class="line"><span class="cl"><span class="s">{
</span></span></span><span class="line"><span class="cl"><span class="s"> &#34;Hello&#34;: &#34;World&#34;
</span></span></span><span class="line"><span class="cl"><span class="s">}
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">name</span><span class="p">=</span><span class="s">&#34;XML&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="s">```xml
</span></span></span><span class="line"><span class="cl"><span class="s">&lt;Hello&gt;World&lt;/Hello&gt;
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">name</span><span class="p">=</span><span class="s">&#34;properties&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="s">```properties
</span></span></span><span class="line"><span class="cl"><span class="s">Hello = World
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="json"
data-tab-group="tabs-example-config"
class="tab-nav-button direction-ltr active"
onclick="switchTab('tabs-example-config','json')"
><span>json</span></button>
<button
data-tab-item="XML"
data-tab-group="tabs-example-config"
class="tab-nav-button direction-ltr "
onclick="switchTab('tabs-example-config','XML')"
><span>XML</span></button>
<button
data-tab-item="properties"
data-tab-group="tabs-example-config"
class="tab-nav-button direction-ltr "
onclick="switchTab('tabs-example-config','properties')"
><span>properties</span></button>
</div>
<div class="tab-content">
<div data-tab-item="json" data-tab-group="tabs-example-config" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;Hello&#34;</span><span class="p">:</span> <span class="s2">&#34;World&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="XML" data-tab-group="tabs-example-config" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-xml" data-lang="xml"><span class="line"><span class="cl"><span class="nt">&lt;Hello&gt;</span>World<span class="nt">&lt;/Hello&gt;</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="properties" data-tab-group="tabs-example-config" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-ini" data-lang="ini"><span class="line"><span class="cl"><span class="na">Hello</span> <span class="o">=</span> <span class="s">World</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<h3 id="non-distinct-groupid">Non-Distinct <code>groupid</code></h3>
<p>See what happens to this tab view if you select <strong>properties</strong> tab from the previous example.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="nx">tabs</span> <span class="nx">groupid</span><span class="p">=</span><span class="s">&#34;config&#34;</span> <span class="p">&gt;}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">name</span><span class="p">=</span><span class="s">&#34;json&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="s">```json
</span></span></span><span class="line"><span class="cl"><span class="s">{
</span></span></span><span class="line"><span class="cl"><span class="s"> &#34;Hello&#34;: &#34;World&#34;
</span></span></span><span class="line"><span class="cl"><span class="s">}
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">name</span><span class="p">=</span><span class="s">&#34;XML&#34;</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="s">```xml
</span></span></span><span class="line"><span class="cl"><span class="s">&lt;Hello&gt;World&lt;/Hello&gt;
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">tab</span> <span class="o">%</span><span class="p">}}</span>
</span></span><span class="line"><span class="cl"><span class="p">{{&lt;</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">&gt;}}</span>
</span></span></code></pre></div>
<div class="tab-panel">
<div class="tab-nav">
<button
data-tab-item="json"
data-tab-group="tabs-example-config"
class="tab-nav-button direction-ltr active"
onclick="switchTab('tabs-example-config','json')"
><span>json</span></button>
<button
data-tab-item="XML"
data-tab-group="tabs-example-config"
class="tab-nav-button direction-ltr "
onclick="switchTab('tabs-example-config','XML')"
><span>XML</span></button>
</div>
<div class="tab-content">
<div data-tab-item="json" data-tab-group="tabs-example-config" class="tab-item active">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;Hello&#34;</span><span class="p">:</span> <span class="s2">&#34;World&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre></div>
</div>
<div data-tab-item="XML" data-tab-group="tabs-example-config" class="tab-item ">
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-xml" data-lang="xml"><span class="line"><span class="cl"><span class="nt">&lt;Hello&gt;</span>World<span class="nt">&lt;/Hello&gt;</span>
</span></span></code></pre></div>
</div>
</div>
</div>
<footer class="footline">
</footer>
</article>
</section> </div>
</main>
</div>
<aside id="sidebar" class="default-animation showVisitedLinks" dir="ltr">
<div id="header-wrapper" class="default-animation">
<div id="header" class="default-animation">
<style>
#logo svg,
#logo svg * {
color: #282828;
color: var(--MENU-SECTIONS-BG-color);
fill: #282828 !important;
fill: var(--MENU-SECTIONS-BG-color) !important;
opacity: .945;
}
a#logo {
color: #282828;
color: var(--MENU-SECTIONS-BG-color);
font-family: 'Work Sans', 'Helvetica', 'Tahoma', 'Geneva', 'Arial', sans-serif;
font-size: 30px;
font-weight: 300;
margin-top: -13px;
max-width: 60%;
text-transform: uppercase;
width: 226px;
white-space: nowrap;
}
a#logo:hover {
color: #282828;
color: var(--MENU-SECTIONS-BG-color);
}
#logo svg {
margin-bottom: -20px;
margin-left: -23.5px;
width: 40.5%;
}
@media only all and (max-width: 59.938em) {
a#logo {
font-size: 25px;
margin-top: -3px;
}
#logo svg {
margin-bottom: -12px;
margin-left: -23px;
}
}
@media all and (-ms-high-contrast:none) {
/* IE11s understanding of positioning is weird at best */
a#logo {
margin-top: -58px;
}
#logo svg {
margin-bottom: -62px;
}
}
</style>
<a id="logo" href="../index.html">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64.044 64.044">
<path d="M46.103 136.34c-.642-.394-1.222-2.242-1.98-2.358-.76-.117-1.353.506-1.618 1.519-.266 1.012-.446 4.188.173 5.538.213.435.482.787 1.03.845.547.057.967-.504 1.45-1.027.482-.523.437-.9 1.142-.612.705.289 1.051.4 1.586 1.229.535.828 1.085 4.043.868 5.598-.241 1.458-.531 2.8-.59 4.088.26.075.517.148.772.217 2.68.724 5.373 1.037 7.873.02.001-.028.01-.105.008-.11-.048-.165-.18-.41-.36-.698-.18-.29-.414-.645-.586-1.114a3.212 3.212 0 0 1-.125-1.735c.056-.21.153-.342.249-.475 1.237-1.193 2.932-1.373 4.244-1.384.557-.004 1.389.016 2.198.255.809.239 1.706.724 2.068 1.843.187.578.114 1.17-.043 1.623-.153.438-.369.783-.545 1.091-.178.31-.329.6-.401.821-.007.02-.003.071-.005.094 2.256 1.008 4.716.91 7.189.398.55-.114 1.11-.247 1.673-.377.344-1.085.678-2.145.852-3.208.124-.752.158-2.311-.078-3.538-.118-.613-.306-1.15-.52-1.489-.221-.349-.413-.501-.747-.538-.243-.027-.51.013-.796.098-.67.223-1.33.606-1.966.76l-.008.002-.109.032c-.556.152-1.233.158-1.797-.36-.556-.51-.89-1.367-1.117-2.596-.283-1.528-.075-3.279.89-4.518l.071-.09h.07c.65-.71 1.485-.802 2.16-.599.706.213 1.333.629 1.772.84.736.354 1.185.319 1.475.171.291-.148.5-.439.668-.955.332-1.017.301-2.819.022-4.106-.148-.684-.13-1.292-.13-1.883-1.558-.463-3.067-.982-4.574-1.208-1.128-.169-2.263-.173-3.298.164-.13.046-.256.095-.38.15-.373.164-.633.342-.805.52-.077.098-.081.105-.087.21-.004.068.031.289.13.571.1.282.256.634.467 1.03.279.524.448 1.063.431 1.618a2.12 2.12 0 0 1-.499 1.309 1.757 1.757 0 0 1-.62.51h-.002c-.515.291-1.107.404-1.723.464-.86.083-1.787.026-2.598-.097-.806-.123-1.47-.28-1.948-.555-.444-.256-.79-.547-1.037-.925a2.273 2.273 0 0 1-.356-1.301c.029-.837.403-1.437.625-1.897.111-.23.191-.433.236-.583.045-.15.044-.25.046-.24-.005-.029-.127-.355-1.015-.741-1.138-.495-2.322-.673-3.533-.668h-.015a9.711 9.711 0 0 0-.521.016h-.002c-1.163.057-2.35.308-3.541.569.383 1.531.79 2.753.818 4.502-.096 1.297.158 2.114-1.03 2.935-.85.588-1.508.729-2.15.335" style="fill:#282828;fill-opacity:1;stroke:none;stroke-width:1.03763;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
<path d="M61.472 101.34v.002c-.3-.003-.603.01-.894.04-.544.055-1.39.165-1.778.306-1.238.364.13 2.344.41 2.913.28.569.285 2.03.14 2.134-.144.103-.375.261-.934.345-.56.084.03-.037-1.589.086-1.62.122-5.506.29-8.265.248-.022.26-.036.521-.097.808-.309 1.442-.63 3.163-.494 4.074.071.473.168.65.414.8.23.14.737.235 1.62-.004.834-.227 1.3-.442 1.887-.456.595-.016 1.555.472 1.965.717.411.245-.03-.008.002 0s.128.05.176.102c.049.053-.276-.523.104.199.379.721.72 3.256.002 4.68-.46.913-1.01 1.49-1.64 1.711-.63.22-1.229.067-1.734-.135-.881-.353-1.584-.7-2.205-.647-1.199 1.94-1.186 4.17-.6 6.602.097.397.212.814.327 1.23 2.68-.556 5.542-1.016 8.337.132 1.064.437 1.73 1.015 1.902 1.857.169.831-.193 1.508-.438 1.986-.122.238-.23.46-.307.642-.07.164-.096.28-.104.324.069.429.309.723.686.945.385.227.89.355 1.35.423.723.104 1.567.152 2.287.086.693-.064 1.032-.338 1.241-.544a2.447 2.447 0 0 0 .303-.437.175.175 0 0 0 .013-.035c-.004-.066-.037-.246-.195-.527-.46-.816-.87-1.595-.817-2.51.028-.476.218-.938.529-1.288.304-.343.698-.586 1.186-.79 1.442-.606 2.96-.609 4.372-.409 1.525.216 2.963.679 4.378 1.083.226-2.09.784-3.9.592-5.77-.058-.565-.287-1.333-.598-1.827-.32-.508-.59-.717-1.036-.642-.648.11-1.472.935-2.707 1.078-.791.092-1.494-.267-1.95-.86-.45-.583-.678-1.335-.78-2.101-.202-1.525.031-3.229.89-4.27.615-.747 1.45-.887 2.15-.74.687.145 1.307.492 1.857.745v-.002c.546.252 1.033.388 1.281.344a.547.547 0 0 0 .353-.188c.113-.124.242-.35.384-.75.604-1.712.206-3.68-.303-5.654-.667.145-1.336.293-2.018.413-1.341.236-2.73.392-4.136.273-.656-.055-1.695-.085-2.58-.476-.442-.195-.903-.514-1.157-1.093-.259-.591-.205-1.313.08-2.014.223-.64 1.082-2.178.692-2.585-.391-.407-1.651-.56-2.554-.571z" style="fill:#282828;fill-opacity:1;stroke:none;stroke-width:.992837;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
<path d="M83.128 98.116c-.484 1.875-1.057 3.757-2.486 5.033-.638.57-1.13.666-1.483.548-.401-.134-.715-.506-1.058-.973-.338-.461-.655-.97-1.076-1.332-.192-.165-.404-.315-.683-.38-.279-.066-.599-.02-.9.102-.489.196-.89.58-1.28 1.047a6.1 6.1 0 0 0-.985 1.632c-.234.591-.356 1.174-.277 1.713.072.487.392.977.905 1.185.463.187.926.156 1.36.154.433 0 .843.01 1.242.147.55.189.79.736.822 1.368.034.66-.145 1.412-.393 1.988l-.008.021c-.74 1.705-1.946 2.893-3.004 4.349l-.664.915.979.099c.924.092 1.788.26 2.468.675.46.281 1.806 1.205 2.794 2.222.497.513.888 1.031 1.047 1.502.078.231.095.422.05.6a.93.93 0 0 1-.345.474c-.301.223-.606.395-.864.532l-.354.186c-.107.058-.189.087-.345.228a.637.637 0 0 1 .062-.045l-.064.041-.209.236-.103.343s.003.126.007.152c.003.017.003.007.004.015v.002c.016.195.061.307.133.476a4.1 4.1 0 0 0 .32.596 5.7 5.7 0 0 0 2.8 2.258c.284.108.908.321 1.548.36.33.02.59.015.912-.13h.002c.08-.037.228-.095.382-.281.153-.186.19-.355.212-.445l.019-.075.003-.078c.023-.585-.037-1.296.072-1.899.153-.657.435-.956 1.009-.909 2.771.239 4.74 1.955 6.693 3.83l.742.714.279-1.155c.55-2.29 1.093-4.464 2.928-5.977.692-.57 1.184-.642 1.527-.509.39.151.676.536.996.995.319.458.605.926 1.07 1.212.194.119.464.232.784.209.32-.024.638-.163.988-.384 1.022-.645 1.778-1.756 2.086-2.942.136-.522.102-.991-.046-1.301-.158-.334-.433-.553-.754-.707-.653-.314-1.468-.373-2.094-.486-.825-.15-1.22-.475-1.345-.878-.13-.417 0-.953.335-1.61.6-1.173 1.887-2.602 3.13-3.911l.498-.526-.449-.432c-1.545-1.49-3.163-3.01-5.252-3.715h-.002c-.473-.16-1.097-.413-1.73-.424h-.003c-.311-.004-.596.04-.883.24v.002c-.22.155-.483.537-.583.937l-.008.036-.006.038c-.116.773-.06 1.467-.217 1.995-.063.212-.198.418-.359.507-.202.111-.492.153-.976.072-.582-.097-1.978-.69-3.021-1.503-.523-.407-.934-.85-1.117-1.3a1.153 1.153 0 0 1-.083-.63c.03-.184.1-.477.308-.593.21-.116.941-.32 1.377-.642h.002c.192-.141.403-.367.518-.64.114-.275.127-.526.123-.774-.006-.142-.036-.192-.08-.3a8.417 8.417 0 0 0-3-3.027c-1.226-.725-2.585-1.135-3.927-1.539-.434-.12-.844-.111-1.02.466zm.912.947c1.186.364 2.357.718 3.345 1.303 1.035.612 1.864 1.488 2.507 2.528-.514.263-1.095.5-1.44.79-.345.29-.729.914-.815 1.434-.084.509 0 .968.155 1.347.301.74.85 1.276 1.44 1.735 1.18.92 2.554 1.545 3.47 1.698.604.1 1.186.088 1.739-.216.594-.327.935-.911 1.088-1.427.264-.884.193-1.664.262-2.17h.1c.3.006.926.206 1.417.371 1.646.554 3.044 1.773 4.431 3.089-1.102 1.174-2.222 2.423-2.888 3.73-.42.823-.73 1.789-.453 2.687.283.913 1.1 1.415 2.138 1.603.691.126 1.472.226 1.84.403.19.091.258.182.278.223.03.064.058.075-.023.387-.21.804-.761 1.598-1.413 2.01-.247.155-.365.183-.407.187-.042.003-.061.002-.172-.066-.144-.088-.455-.473-.772-.929-.317-.454-.714-1.07-1.452-1.356-.783-.304-1.776-.022-2.713.75-1.942 1.6-2.626 3.764-3.146 5.8-1.802-1.676-3.772-3.138-6.589-3.517h-.002c-.346-.095-1.013-.031-1.293.143-.735.501-1.005 1.132-1.168 2.007-.125.69-.082 1.216-.074 1.659-.055.006-.046.01-.104.006-.42-.026-1.035-.215-1.244-.295-.947-.361-1.774-1.006-2.314-1.857-.054-.085-.072-.132-.109-.2l.027-.016c.284-.15.656-.36 1.045-.648.44-.327.789-.798.93-1.35a2.4 2.4 0 0 0-.068-1.379c-.254-.751-.753-1.353-1.295-1.911-1.09-1.124-2.452-2.049-2.99-2.378-.609-.372-1.303-.44-1.981-.56.875-1.094 1.878-2.251 2.596-3.921.294-.823.543-1.907.513-2.658-.049-.97-.489-2.013-1.52-2.367-.579-.2-1.131-.204-1.58-.203-.45.002-.786-.006-.97-.08h-.002c-.264-.107-.236-.108-.268-.33-.025-.17.021-.553.183-.962a4.67 4.67 0 0 1 .725-1.192c.29-.348.617-.59.705-.626.142-.057.176-.05.22-.04.045.011.127.052.263.17.235.201.56.671.92 1.161.354.484.791 1.08 1.543 1.33.8.267 1.784-.052 2.671-.846 1.594-1.424 2.235-3.317 2.714-5.051zm11.705 7.023c-.02.014.042-.002.042 0l-.008.035c.05-.2-.028-.04-.034-.035zM79.472 122.45a.198.198 0 0 1 .005.023v.014c-.002-.01-.003-.03-.005-.037zm-.29.732-.006.01-.044.027c.016-.01.033-.024.05-.036z" style="color:#000;fill:#282828;stroke-width:1.02352;-inkscape-stroke:none" transform="translate(-40.698 -95.175)"/>
<path d="M76.694 128.845c-.85-.012-1.668.253-2.434.67-.01.592-.015 1.17.109 1.772.323 1.573.422 3.553-.07 5.147-.247.804-.684 1.535-1.347 1.891-.663.356-1.467.296-2.362-.159-.522-.266-1.059-.62-1.487-.757-.223-.072-.392-.096-.522-.069-.13.027-.232.094-.362.27-.53.719-.681 1.823-.497 2.876.177 1.012.418 1.438.543 1.56.143.137.26.154.604.055.548-.158 1.523-.857 2.573-.972l.02-.002.5.058c.686.081 1.247.562 1.622 1.19.372.62.591 1.37.73 2.136.279 1.532.25 3.16.083 4.232-.14.91-.394 1.72-.632 2.53 1.719-.385 3.485-.692 5.307-.36 1.174.214 2.749.574 3.762 1.977l.088.122.046.159c.162.551.16 1.114.024 1.578-.13.45-.348.772-.533 1.023-.181.246-.336.444-.437.606-.102.16-.141.275-.145.336-.01.17 0 .197.07.315.057.1.186.242.39.366.408.246 1.106.414 1.843.45a7.842 7.842 0 0 0 2.174-.21 4.28 4.28 0 0 0 .822-.296c.218-.106.385-.242.377-.233l.029-.031c.025-.035.05-.072.05-.068 0-.004 0-.017-.003-.05a2.733 2.733 0 0 0-.21-.579c-.26-.548-.839-1.333-.822-2.46.01-.657.27-1.21.598-1.576.32-.357.696-.575 1.074-.736.759-.323 1.57-.418 2.054-.458 1.653-.136 3.252.296 4.755.765.457.142.905.29 1.352.434.325-2.258.902-4.247.598-6.217-.071-.46-.25-1.169-.486-1.684-.238-.518-.495-.762-.675-.779-.351-.032-.716.14-1.174.418-.457.277-1.005.665-1.695.742-.745.082-1.406-.291-1.84-.908-.428-.608-.653-1.394-.754-2.196-.203-1.596.016-3.377.794-4.493.568-.813 1.358-.984 2.024-.835.65.146 1.243.51 1.769.779.524.267.99.413 1.237.365a.527.527 0 0 0 .346-.2c.11-.132.235-.373.37-.798.612-1.918.27-3.894-.246-6.054-2.815-.851-5.49-1.534-8.089-.267a.727.727 0 0 0-.223.148c-.024.028-.018.021-.026.056.001-.003-.01.178.07.44.162.522.611 1.29.911 1.978l.004.009.029.063.024.084V133c.162.635.016 1.297-.274 1.727-.272.404-.618.636-.952.81-.675.353-1.399.484-1.724.533a5.888 5.888 0 0 1-3.973-.795c-.512-.311-.876-.594-1.133-1.02-.282-.466-.318-1.084-.172-1.557.252-.814.715-1.266.971-1.89a.663.663 0 0 0 .047-.14c.001-.013 0-.006-.007-.037a.761.761 0 0 0-.184-.268c-.264-.267-.865-.595-1.54-.826-1.356-.462-3.07-.659-3.583-.686-.062-.002-.121-.006-.178-.006z" style="fill:#282828;fill-opacity:1;stroke:none;stroke-width:.991342;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
</svg>
Relearn
</a>
</div>
<div class="searchbox default-animation">
<label class="a11y-only" for="search-by">Search</label>
<i class="fas fa-search"></i>
<input data-search-input id="search-by" type="search" placeholder="Search...">
<span data-search-clear=""><i class="fas fa-times"></i></span>
</div>
<script>
var contentLangs=['en'];
</script>
<script src="../js/auto-complete.js?1668291727" defer></script>
<script src="../js/lunr.min.js?1668291727" defer></script>
<script src="../js/lunr.stemmer.support.min.js?1668291727" defer></script>
<script src="../js/lunr.multi.min.js?1668291727" defer></script>
<script src="../js/lunr.en.min.js?1668291727" defer></script>
<script src="../js/search.js?1668291727" defer></script>
</div>
<div id="content-wrapper" class="highlightable">
<ul class="topics collapsible-menu">
<li data-nav-id="/basics/" class="dd-item"><input type="checkbox" id="section-df6aa773bd1fbc430ade79f1764e4ce7" aria-controls="subsections-df6aa773bd1fbc430ade79f1764e4ce7" class="toggle"><label class="a11y-only toggle" for="section-df6aa773bd1fbc430ade79f1764e4ce7" >Submenu Basics</label><a href="../basics/index.html">1. Basics<i class="fas fa-check read-icon"></i></a><ul id="subsections-df6aa773bd1fbc430ade79f1764e4ce7">
<li data-nav-id="/basics/migration/" class="dd-item"><a href="../basics/migration/index.html">What&#39;s new<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/basics/requirements/" class="dd-item"><a href="../basics/requirements/index.html">Requirements<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/basics/installation/" class="dd-item"><a href="../basics/installation/index.html">Installation<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/basics/configuration/" class="dd-item"><a href="../basics/configuration/index.html">Configuration<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/basics/customization/" class="dd-item"><a href="../basics/customization/index.html">Customization<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/basics/generator/" class="dd-item"><a href="../basics/generator/index.html">Stylesheet generator<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/basics/history/" class="dd-item"><a href="../basics/history/index.html">History<i class="fas fa-check read-icon"></i></a></li></ul></li>
<li data-nav-id="/cont/" class="dd-item"><input type="checkbox" id="section-2291d2894a4301fd505172f85eca0c0a" aria-controls="subsections-2291d2894a4301fd505172f85eca0c0a" class="toggle"><label class="a11y-only toggle" for="section-2291d2894a4301fd505172f85eca0c0a" >Submenu Content</label><a href="../cont/index.html">2. Content<i class="fas fa-check read-icon"></i></a><ul id="subsections-2291d2894a4301fd505172f85eca0c0a">
<li data-nav-id="/cont/pages/" class="dd-item"><a href="../cont/pages/index.html">Pages organization<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/cont/archetypes/" class="dd-item"><a href="../cont/archetypes/index.html">Archetypes<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/cont/markdown/" class="dd-item"><a href="../cont/markdown/index.html">Markdown syntax<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/cont/syntaxhighlight/" class="dd-item"><a href="../cont/syntaxhighlight/index.html">Code highlighting<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/cont/menushortcuts/" class="dd-item"><a href="../cont/menushortcuts/index.html">Menu extra shortcuts<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/cont/icons/" class="dd-item"><a href="../cont/icons/index.html">Icons and logos<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/cont/i18n/" class="dd-item"><a href="../cont/i18n/index.html">Multilingual and i18n<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/cont/tags/" class="dd-item"><a href="../cont/tags/index.html">Tags<i class="fas fa-check read-icon"></i></a></li></ul></li>
<li data-nav-id="/shortcodes/" class="dd-item active parent"><input type="checkbox" id="section-c0549379138a5c256f6c0600d532453f" aria-controls="subsections-c0549379138a5c256f6c0600d532453f" class="toggle" checked><label class="a11y-only toggle" for="section-c0549379138a5c256f6c0600d532453f" >Submenu Shortcodes</label><a href="../shortcodes/index.html">3. Shortcodes<i class="fas fa-check read-icon"></i></a><ul id="subsections-c0549379138a5c256f6c0600d532453f">
<li data-nav-id="/shortcodes/attachments/" class="dd-item"><a href="../shortcodes/attachments/index.html">Attachments<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/button/" class="dd-item"><a href="../shortcodes/button/index.html">Button<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/children/" class="dd-item"><input type="checkbox" id="section-efce957ff9dad000e250ff868aa3291d" aria-controls="subsections-efce957ff9dad000e250ff868aa3291d" class="toggle"><label class="a11y-only toggle" for="section-efce957ff9dad000e250ff868aa3291d" >Submenu Children</label><a href="../shortcodes/children/index.html">Children<i class="fas fa-check read-icon"></i></a><ul id="subsections-efce957ff9dad000e250ff868aa3291d">
<li data-nav-id="/shortcodes/children/test/" class="dd-item"><a href="../shortcodes/children/test/index.html">page X<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/children/children-1/" class="dd-item"><input type="checkbox" id="section-c27b80e9c4c5ceb911093893f4f00a2b" aria-controls="subsections-c27b80e9c4c5ceb911093893f4f00a2b" class="toggle"><label class="a11y-only toggle" for="section-c27b80e9c4c5ceb911093893f4f00a2b" >Submenu page 1</label><a href="../shortcodes/children/children-1/index.html">page 1<i class="fas fa-check read-icon"></i></a><ul id="subsections-c27b80e9c4c5ceb911093893f4f00a2b">
<li data-nav-id="/shortcodes/children/children-1/children-1-1/" class="dd-item alwaysopen"><input type="checkbox" id="section-bc0c0185f32af18e77e51e4a5f0a3ba4" aria-controls="subsections-bc0c0185f32af18e77e51e4a5f0a3ba4" class="toggle" checked><label class="a11y-only toggle" for="section-bc0c0185f32af18e77e51e4a5f0a3ba4" >Submenu page 1-1</label><a href="../shortcodes/children/children-1/children-1-1/index.html">page 1-1<i class="fas fa-check read-icon"></i></a><ul id="subsections-bc0c0185f32af18e77e51e4a5f0a3ba4">
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-2/" class="dd-item alwaysopen"><input type="checkbox" id="section-9c0a5b93d94f133c09f9cec9eec310a6" aria-controls="subsections-9c0a5b93d94f133c09f9cec9eec310a6" class="toggle" checked><label class="a11y-only toggle" for="section-9c0a5b93d94f133c09f9cec9eec310a6" >Submenu page 1-1-2</label><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">page 1-1-2<i class="fas fa-check read-icon"></i></a><ul id="subsections-9c0a5b93d94f133c09f9cec9eec310a6">
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/" class="dd-item"><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">page 1-1-2-1<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/" class="dd-item"><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html">page 1-1-2-2<i class="fas fa-check read-icon"></i></a></li></ul></li>
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-3/" class="dd-item"><a href="../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3<i class="fas fa-check read-icon"></i></a></li></ul></li></ul></li>
<li data-nav-id="/shortcodes/children/children-2/" class="dd-item"><a href="../shortcodes/children/children-2/index.html">page 2<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/children/children-3/" class="dd-item"><input type="checkbox" id="section-801eeaaa0748a0846cc1e95f3a734fb7" aria-controls="subsections-801eeaaa0748a0846cc1e95f3a734fb7" class="toggle"><label class="a11y-only toggle" for="section-801eeaaa0748a0846cc1e95f3a734fb7" >Submenu page 3</label><a href="../shortcodes/children/children-3/index.html">page 3<i class="fas fa-check read-icon"></i></a><ul id="subsections-801eeaaa0748a0846cc1e95f3a734fb7">
<li data-nav-id="/shortcodes/children/children-3/test3/" class="dd-item"><a href="../shortcodes/children/children-3/test3/index.html">page 3-1<i class="fas fa-check read-icon"></i></a></li></ul></li></ul></li>
<li data-nav-id="/shortcodes/expand/" class="dd-item"><a href="../shortcodes/expand/index.html">Expand<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/include/" class="dd-item"><a href="../shortcodes/include/index.html">Include<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/math/" class="dd-item"><a href="../shortcodes/math/index.html">Math<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/mermaid/" class="dd-item"><a href="../shortcodes/mermaid/index.html">Mermaid<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/notice/" class="dd-item"><a href="../shortcodes/notice/index.html">Notice<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/siteparam/" class="dd-item"><a href="../shortcodes/siteparam/index.html">Site param<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/swagger/" class="dd-item"><a href="../shortcodes/swagger/index.html">Swagger<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id="/shortcodes/tabs/" class="dd-item"><a href="../shortcodes/tabs/index.html">Tabbed views<i class="fas fa-check read-icon"></i></a></li></ul></li>
</ul>
<div id="shortcuts">
<div class="nav-title">More</div>
<ul>
<li><a class="padding" href="https://github.com/McShelby/hugo-theme-relearn"><i class='fab fa-fw fa-github'></i> GitHub repo</a></li>
<li><a class="padding" href="../more/showcase/index.html"><i class='fas fa-fw fa-camera'></i> Showcases</a></li>
<li><a class="padding" href="https://gohugo.io/"><i class='fas fa-fw fa-bookmark'></i> Hugo Documentation</a></li>
<li><a class="padding" href="../more/credits/index.html"><i class='fas fa-fw fa-bullhorn'></i> Credits</a></li>
<li><a class="padding" href="../tags/index.html"><i class='fas fa-fw fa-tags'></i> Tags</a></li>
</ul>
</div>
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showLangSwitch showVariantSwitch showVisitedLinks showFooter"></div>
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showLangSwitch showVariantSwitch showVisitedLinks showFooter">
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks showLangSwitch showVariantSwitch showVisitedLinks">
<ul>
<li id="select-language-container" class="footerLangSwitch showLangSwitch">
<div class="padding select-container">
<i class="fas fa-language fa-fw"></i>
<span>&nbsp;</span>
<div class="select-style">
<label class="a11y-only" for="select-language">Language</label>
<select id="select-language" onchange="location = baseUri + this.value;">
<option lang="pir" id="pir" value="/pir/shortcodes/index.html">Arrr! ☠ Pirrrates ☠</option>
<option lang="en" id="en" value="/shortcodes/index.html" selected>English</option>
</select>
</div>
<div class="select-clear"></div>
</div>
</li>
<li id="select-variant-container" class="footerVariantSwitch showVariantSwitch">
<div class="padding select-container">
<i class="fas fa-paint-brush fa-fw"></i>
<span>&nbsp;</span>
<div class="select-style">
<label class="a11y-only" for="select-variant">Theme</label>
<select id="select-variant" onchange="window.variants && variants.changeVariant( this.value );">
<option id="relearn-light" value="relearn-light" selected>Relearn Light</option>
<option id="relearn-dark" value="relearn-dark">Relearn Dark</option>
<option id="learn" value="learn">Learn</option>
<option id="neon" value="neon">Neon</option>
<option id="blue" value="blue">Blue</option>
<option id="green" value="green">Green</option>
<option id="red" value="red">Red</option>
</select>
</div>
<div class="select-clear"></div>
</div>
<script>window.variants && variants.markSelectedVariant();</script>
</li>
<li class="footerVisitedLinks showVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i> Clear History</button></li>
</ul>
</div>
<div id="footer" class="footerFooter showFooter">
<style>
#footer {
font-size: 13px;
height: 100px;
margin-left: auto;
margin-right: auto;
padding: 2rem 1rem;
text-align: center;
min-width: 230px;
max-width: 300px;
}
#footer p {
margin: 0;
}
</style>
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip" data-icon="octicon-cloud-download" aria-label="Download McShelby/hugo-theme-relearn on GitHub">Download</a>
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn" data-icon="octicon-star" data-show-count="true" aria-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
<script async src="../js/buttons.js?1668291727"></script>
</div>
</div>
</aside>
<script src="../js/clipboard.min.js?1668291727" defer></script>
<script src="../js/perfect-scrollbar.min.js?1668291727" defer></script>
<script src="../js/featherlight.min.js?1668291727" defer></script>
<script>
function useMathJax( config ){
if( !Object.assign ){
return;
}
window.MathJax = Object.assign( window.MathJax || {}, {
loader: {
load: ['[tex]/mhchem']
},
startup: {
elements: [
'.math'
]
},
tex: {
inlineMath: [
['$', '$'],
['\\(', '\\)']
]
},
options: {
enableMenu: false
}
}, config );
}
useMathJax( JSON.parse("{}") );
</script>
<script id="MathJax-script" async src="../js/mathjax/tex-mml-chtml.js?1668291727"></script>
<script src="../js/jquery.svg.pan.zoom.js?1668291727" defer></script>
<script src="../js/mermaid.min.js?1668291727" defer></script>
<script>
window.themeUseMermaid = JSON.parse("{ \"securityLevel\": \"loose\" }");
</script>
<script src="../js/rapidoc-min.js?1668291727" defer></script>
<script>
window.themeUseSwagger = JSON.parse("{}");
</script>
<script src="../js/theme.js?1668291727" defer></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink