mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 18:53:18 +00:00
4197 lines
334 KiB
HTML
4197 lines
334 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="pir">
|
||
<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.96.0" />
|
||
<meta name="generator" content="Relearn 3.4.1+tip">
|
||
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
||
<meta name="author" content="Sören Weber">
|
||
<title>Cap'n Hugo Relearrrn Theme</title>
|
||
<link rel="canonical" type="text/html" href="/hugo-theme-relearn/pir/" title="Cap'n Hugo Relearrrn Theme" />
|
||
<link rel="alternate" type="application/rss+xml" href="/hugo-theme-relearn/pir/index.xml" title="Cap'n Hugo Relearrrn Theme" />
|
||
<link rel="icon" href="/hugo-theme-relearn/images/logo.svg?1649711126" type="image/svg+xml">
|
||
<link href="/hugo-theme-relearn/css/nucleus.css?1649711126" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1649711126" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/featherlight.min.css?1649711126" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1649711126" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/auto-complete.css?1649711126" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/theme.css?1649711126" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/theme-relearn-light.css?1649711126" rel="stylesheet" id="variant-style">
|
||
<link href="/hugo-theme-relearn/css/variant.css?1649711126" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/print.css?1649711126" rel="stylesheet">
|
||
<script src="/hugo-theme-relearn/js/variant.js?1649711126"></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
|
||
var index_url="/hugo-theme-relearn/pir/index.json";
|
||
var root_url="/";
|
||
var baseUri=root_url.replace(/\/$/, '');
|
||
// translations
|
||
window.T_Copy_to_clipboard = 'Copy t\u0027 clipboard';
|
||
window.T_Copied_to_clipboard = 'Copied t\u0027 clipboard!';
|
||
window.T_Copy_link_to_clipboard = 'Copy link t\u0027 clipboard';
|
||
window.T_Link_copied_to_clipboard = 'Copied link t\u0027 clipboard!';
|
||
// some further base stuff
|
||
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||
variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
||
</script>
|
||
<script src="/hugo-theme-relearn/js/jquery.min.js?1649711126"></script>
|
||
</head>
|
||
<body class="mobile-support print" data-url="/hugo-theme-relearn/pir/">
|
||
<div id="body" class="default-animation">
|
||
<div id="sidebar-overlay"></div>
|
||
<div id="toc-overlay"></div>
|
||
<nav id="topbar" class="highlightable">
|
||
<div>
|
||
<div class="navigation">
|
||
<a class="nav nav-next" href="/hugo-theme-relearn/pir/basics/" title="Basics"><i class="fas fa-chevron-right fa-fw"></i></a>
|
||
</div>
|
||
<div class="navigation">
|
||
<span class="nav nav-prev"><i class="fa fa-chevron-left fa-fw"></i></span>
|
||
</div>
|
||
<div id="top-print-link">
|
||
<a class="print-link" title='Prrrint whole chapterrr' href="/hugo-theme-relearn/pir/_print/">
|
||
<i class="fas fa-print fa-fw"></i>
|
||
</a>
|
||
</div>
|
||
<div id="top-github-link">
|
||
<a class="github-link" title='Edit' href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content//_index.pir.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'><i class="fas fa-bars fa-fw"></i></a>
|
||
</span>
|
||
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
||
<meta itemprop="itemListOrder" content="Descending" />
|
||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><meta itemprop="position" content="1" /><a itemprop="item" href="/hugo-theme-relearn/pir/" aria-disabled="true"><span itemprop="name">Cap'n Hugo Relearrrn Theme</span></a></li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
<main id="body-inner" class="highlightable">
|
||
<div class="flex-block-wrapper">
|
||
<div id="head-tags">
|
||
</div>
|
||
|
||
<article>
|
||
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<h1 id="hugo-relearn-theme">Cap'n Hugo Relearrrn Theme</h1>
|
||
<p>Th' <a href="http://github.com/McShelby/hugo-theme-relearn">Relearrrn theme</a> be a theme fer <a href="https://gohugo.io/">Cap'n Hugo</a>, a static website generator written 'n Go. Whar' Cap'n Hugo be often used fer blogs, this theme be designed wit' documentat'n 'n mind.</p>
|
||
|
||
<div class="box notices info">
|
||
<div class="box-label"><i class="fas fa-info-circle fa-fw"></i> Ahoi</div>
|
||
<div class="box-content">
|
||
<p>Th' theme be a fork o' th' great <a href="https://github.com/matcornic/hugo-theme-learn">Learrrn theme</a> wit' th' aim o' fix'n long outstand'n bugs an' adept'n t' latest Cap'n Hugo features. As far as poss'ble this theme tries t' be a drop-in replacement fer th' Learrrn theme.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 id="main-features">Main features</h2>
|
||
|
||
<div class="box notices tip">
|
||
<div class="box-label"><i class="fas fa-lightbulb fa-fw"></i> Smarrrt Arrrse</div>
|
||
<div class="box-content">
|
||
<p>See <a href="/hugo-theme-relearn/pir/basics/migration/">what’s new</a> within th' latest update.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<ul>
|
||
<li>Us'ble offline, no external dependencies</li>
|
||
<li>Support fer Internet Explorer 11</li>
|
||
<li>Responsive design</li>
|
||
<li>Configur'ble hidden planks</li>
|
||
<li>Automatic next/prev buttons t' navigate through menu entries</li>
|
||
<li><a href="/hugo-theme-relearn/pir/basics/configuration/#activate-search">Automatic Search</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/basics/configuration/#activate-print-support">Print</a> whole chapters or even th' complete ship</li>
|
||
<li><a href="/hugo-theme-relearn/pir/cont/i18n/">Multilingual mode</a> fer English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese</li>
|
||
<li><a href="/hugo-theme-relearn/pir/cont/menushortcuts/">Unrestricted menu configurat'n</a> relat'n t' amount o' items an' level o' nest'n</li>
|
||
<li><a href="/hugo-theme-relearn/pir/cont/icons/">Font Awesome ay'cons</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/cont/tags/">Tagg'n support</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/cont/markdown/#images">Image resiz'n, shadow…</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/cont/syntaxhighlight/">Rules highlight'n</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/attachments/">Attachments files</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/">List child planks</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/mermaid/">Merrrmaid diagrams</a> fer flowcharts, sequences, gantts, pie, etc.</li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/swagger/">Swagger UI</a> fer OpenAPI Specificat'ns</li>
|
||
<li><a href="/hugo-theme-relearn/pir/basics/customization/">Customiz'ble look an' feel</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/basics/generator/">Predefined (light, dark) an' customiz'ble color variants</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/button/">Buttons</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/notice/">Tip/Note/Info/Warn'n boxes</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/expand/">Expand</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/tabs/">Tabs</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/include/">File inclusion</a></li>
|
||
</ul>
|
||
<h2 id="getting-support">Gett'n support</h2>
|
||
<p>T' get support, feel free t' open a new <a href="https://github.com/McShelby/hugo-theme-relearn/discussions">discussion topic</a> or <a href="https://github.com/McShelby/hugo-theme-relearn/issues">issue</a> 'n th' official repository on GitHub.</p>
|
||
<h2 id="become-a-contributor">Become a contributor</h2>
|
||
<p>Feel free t' update this documentat'n by just click'n th' <strong>Edit</strong> link displayed on top right o' each plank. Yer changes will be deployed automatically once they were reviewed.</p>
|
||
<p>Ye be most welcome t' contribute bugfixes or even new features t' th' source code by mak'n pull requests t' th' <a href="https://github.com/McShelby/hugo-theme-relearn">official repository</a> via GitHub. Please visit th' <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/contribut'n.md">contribut'n guidelines</a> first.</p>
|
||
<h2 id="license">License</h2>
|
||
<p>This theme be licensed under th' <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE">MIT License</a>.</p>
|
||
<h2 id="credits">Credits</h2>
|
||
<p>This theme would not be poss'ble without th' work o' many others. See th' <a href="/hugo-theme-relearn/pir/more/credits/">credits</a> fer a detailed list.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
<section>
|
||
|
||
<article class="chapter">
|
||
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<h3 id="chapter-1">Chapter 1</h3>
|
||
<h1 id="basics">Basics</h1>
|
||
<p>Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
<section>
|
||
|
||
<article>
|
||
|
||
<h1>Requirrrements</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.</p>
|
||
<p>Just download latest version o' <a href="https://gohugo.io/getting-started/installing/">Cap'n Hugo binary</a> fer yer OS (Windows, Linux, Mac) : it’s that simple.</p>
|
||
<p><img src="/hugo-theme-relearn/basics/requirements/images/magic.gif?classes=shadow" alt="Magic"></p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Installat'n</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this <a href="https://gohugo.io/overview/quickstart/">great documentat'n fer beginners</a>.</p>
|
||
<h2 id="create-your-project">Create yer project</h2>
|
||
<p>Cap'n Hugo provides a <code>new</code> command t' create a new website.</p>
|
||
<pre tabindex="0"><code>hugo new ship <new_project>
|
||
</code></pre><h2 id="install-the-theme">Install th' theme</h2>
|
||
<p>Install th' Relearrrn theme by follow'n <a href="https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme">this documentat'n</a></p>
|
||
<p>This theme’s repository be: <a href="https://github.com/McShelby/hugo-theme-relearn.git">https://github.com/McShelby/hugo-theme-relearn.git</a></p>
|
||
<p>Alternatively, ye can <a href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip">download th' theme as .zip</a> file an' extract it 'n th' <code>themes</code> directory</p>
|
||
<h2 id="basic-configuration">Basic configurat'n</h2>
|
||
<p>When build'n th' website, ye can set a theme by us'n <code>--theme</code> opt'n. However, we suggest ye modify th' configurat'n file (<code>config.toml</code>) an' set th' theme as th' default. Ye can also add th' <code>[outputs]</code> section t' en'ble th' search functionality.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="c"># Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">theme</span> <span class="p">=</span> <span class="s2">"hugo-theme-relearn"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># For search functionality</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">outputs</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">home</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"HTML"</span><span class="p">,</span> <span class="s2">"RSS"</span><span class="p">,</span> <span class="s2">"JSON"</span><span class="p">]</span>
|
||
</span></span></code></pre></div><h2 id="create-your-first-chapter-page">Create yer first chapter plank</h2>
|
||
<p>Chapters be planks that contain other child planks. It has a special layout style an' usually just contains a <em>chapter name</em>, th' <em>title</em> an' a <em>brief abstract</em> o' th' section.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="gu">### Chapter 1
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
||
</span></span><span class="line"><span class="cl"><span class="gh"># Basics
|
||
</span></span></span><span class="line"><span class="cl"><span class="gh"></span>
|
||
</span></span><span class="line"><span class="cl">Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it.
|
||
</span></span></code></pre></div><p>renders as</p>
|
||
<p><img src="/hugo-theme-relearn/basics/installation/images/chapter.png?classes=shadow&width=60pc" alt="A Chapter"></p>
|
||
<p>Th' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new --kind chapter basics/_index.md
|
||
</span></span></code></pre></div><p>By open'n th' given file, ye should see th' property <code>chapter=true</code> on top, mean'n this plank be a <em>chapter</em>.</p>
|
||
<p>By default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property <code>draft: true</code> from th' metadata.</p>
|
||
<h2 id="create-your-first-content-pages">Create yer first rrrambl'n planks</h2>
|
||
<p>Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new basics/first-content.md
|
||
</span></span><span class="line"><span class="cl">hugo new basics/second-content/_index.md
|
||
</span></span></code></pre></div><p>Feel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' <code>title</code> value 'n th' beginn'n o' th' files.</p>
|
||
<h2 id="launching-the-website-locally">Launch'n th' website locally</h2>
|
||
<p>Launch by us'n th' follow'n command:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo serve
|
||
</span></span></code></pre></div><p>Go t' <code>http://localhost:1313</code></p>
|
||
<p>Ye should notice three th'ns:</p>
|
||
<ol>
|
||
<li>Ye have a left-side <strong>Basics</strong> menu, contain'n two submenus wit' names equal t' th' <code>title</code> properties 'n th' previously created files.</li>
|
||
<li>Th' home plank explains how t' cust'mize it by follow'n th' instruct'ns.</li>
|
||
<li>When ye run <code>hugo serve</code>, when th' contents o' th' files change, th' plank automatically refreshes wit' th' changes. Neat!</li>
|
||
</ol>
|
||
<h2 id="build-the-website">Build th' website</h2>
|
||
<p>When yer ship be ready t' deploy, run th' follow'n command:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo
|
||
</span></span></code></pre></div><p>A <code>public</code> folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.</p>
|
||
|
||
<div class="box notices note">
|
||
<div class="box-label"><i class="fas fa-exclamation-circle fa-fw"></i> Avast</div>
|
||
<div class="box-content">
|
||
<p>This website can be automatically published an' hosted wit' <a href="https://www.netlify.com/">Netlify</a> (Read more about <a href="https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/">Automated HUGO deployments wit' Netlify</a>). Alternatively, ye can use <a href="https://gohugo.io/hosting-and-deployment/hosting-on-github/">GitHub planks</a></p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Migrrrat'n</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This document shows ye what’s new 'n th' latest release. For a detailed list o' changes, see th' <a href="/hugo-theme-relearn/pir/basics/history/">history plank</a>.</p>
|
||
<p><strong>Break'n</strong>: A change that requires act'n by ye aft upgrad'n t' assure th' ship be still functional.</p>
|
||
<p><strong>Change</strong>: A change 'n default behavior. This may requires act'n by ye / may or may not be revert'ble by configurat'n.</p>
|
||
<p><strong>New</strong>: Marks new behavior ye might find interest'n or comes configur'ble.</p>
|
||
<hr>
|
||
<h2 id="340">3.4.0</h2>
|
||
<ul>
|
||
<li>
|
||
<p><strong>Break'n</strong>: If ye had previously overwritten th' <code>custom-footer.html</code> partial t' add visual elements below th' rrrambl'n o' yer plank, ye have t' move this rrrambl'n t' th' new partial <code>content-footer.html</code>. <code>custom-footer.html</code> was never meant t' contain HTML other than additional styles an' JavaScript.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: If ye prefer expandable/collaps'ble menu items, ye can now set <code>collapsibleMenu=true</code> 'n yer <code>config.toml</code>. This will add arrows t' all menu items that contain sub menus. Th' menu will expand/collapse without navigat'n if ye click on an arrow.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Ye can activate <a href="/hugo-theme-relearn/pir/basics/configuration/#activate-print-support">print support</a> 'n yer <code>config.toml</code> t' add th' capability t' print whole chapters or even th' complete ship.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Translat'n fer Traditional Chinese.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="330">3.3.0</h2>
|
||
<ul>
|
||
<li>
|
||
<p><strong>New</strong>: Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishs between <code>--MAIN-font</code> fer all rrrambl'n text an' <code>--CODE-font</code> fer inline or block code. There be additional overrides fer all head'ns. See th' <a href="/hugo-theme-relearn/pir/basics/generator/">theme variant generator</a> o' th' exampleSite fer all avail'ble variables.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Th' new shorrrtcode <code>swagger</code> be avail'ble t' include a UI fer REST OpenAPI Specificat'ns. See th' <a href="/hugo-theme-relearn/pir/shortcodes/swagger/">documentat'n</a> fer avail'ble features. This feature will not work wit' Internet Explorer 11.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="320">3.2.0</h2>
|
||
<ul>
|
||
<li>
|
||
<p><strong>Change</strong>: In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shorrrtcode or be us'n Merrrmaid codefences. This changes th' behavior o' <code>disableMermaid</code> config opt'n as follows: If a Merrrmaid shorrrtcode or codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.</p>
|
||
<p>Th' opt'n be still useful 'n case ye be us'n script'n t' set up yer graph. In this case no shorrrtcode or codefence be involved an' th' library be not boarded by default. In this case ye can set <code>disableMermaid=false</code> 'n yer frontmatter t' force th' library t' be boarded. See th' <a href="/hugo-theme-relearn/pir/basics/generator/">theme variant generator</a> o' th' exampleSite fer an example.</p>
|
||
<p><strong>This change requires at least Cap'n Hugo 0.93.0 t' be used</strong>. Th' minimum requirement will be reported dur'n build on th' console if not met.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Additional color variant vari'ble <code>--MERMAID-theme</code> t' set th' variant’s Merrrmaid theme. This causes th' Merrrmaid theme t' switch wit' th' color variant if it defers from th' sett'n o' th' formerly selected color variant.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="310">3.1.0</h2>
|
||
<ul>
|
||
<li><strong>New</strong>: <a href="/hugo-theme-relearn/pir/shortcodes/attachments/"><code>attachment</code></a> an' <a href="/hugo-theme-relearn/pir/shortcodes/notice/"><code>notice</code></a> shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all <a href="https://fontawesome.com/v5/search?m=free">Font Awesome 5 Free</a> ay'cons.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="300">3.0.0</h2>
|
||
<ul>
|
||
<li>
|
||
<p><strong>Break'n</strong>: We made changes t' th' menu footer. If ye have yer <code>menu-footer.html</code> <a href="/hugo-theme-relearn/pir/basics/customization/">partial overridden</a>, ye may have t' review th' styl'n (eg. margins/paddings) 'n yer partial. For a reference take a look into th' <code>menu-footer.html</code> partial that be com'n wit' th' exampleSite.</p>
|
||
<p>This change was made t' allow yer own menu footer t' be placed right aft th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' <em>Clear history</em> functionality).</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Break'n</strong>: We have changed th' default colors from th' original Learrrn theme (the purple menu header) t' th' Relearrrn defaults (the light green menu header) as used 'n th' official documentat'n.</p>
|
||
<p>This change will only affect yer installat'n if you’ve not set th' <code>themeVariant</code> parameter 'n yer <code>config.toml</code>. <a href="/hugo-theme-relearn/pir/basics/customization/#theme-variant">If ye still want t' use th' Learrrn color variant</a>, ye have t' explicitly set <code>themeVariant="learn"</code> 'n yer <code>config.toml</code>.</p>
|
||
<p>Avast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Change</strong>: Due t' a bug, that we couldn’t fix 'n a general manner fer color variants, we decided t' removed <code>--MENU-SEARCH-BOX-ICONS-color</code> an' introduced <code>--MENU-SEARCH-color</code> instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Change</strong>: For consistency reasons, we renamed <code>--MENU-SEARCH-BOX-color</code> t' <code>--MENU-SEARCH-BORDER-color</code>. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Wit' this release ye be now cap'ble t' define yer own <em>dark mode</em> variants.</p>
|
||
<p>T' make this poss'ble, we have introduced a lot more color variables ye can use 'n <a href="/hugo-theme-relearn/pir/basics/customization/#theme-variant">yer color variants</a>. Yer old variants will still work an' don’t need t' be changed as apropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.</p>
|
||
<p>T' see what’s now poss'ble, see th' new variants <code>relearn-dark</code> an' <code>neon</code> that be com'n wit' this release.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive <a href="/hugo-theme-relearn/pir/basics/generator/">theme variant generator</a>. This feature will not work wit' Internet Explorer 11.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Ye can now configure multiple color variants 'n yer <code>config.toml</code>. In this case, th' first variant be th' default chosen on first view an' a variant switch will be shown 'n th' menu footer. See th' <a href="/hugo-theme-relearn/pir/basics/customization/#multiple-variants">documentat'n</a> fer configurat'n.</p>
|
||
<p>Avast, that th' new variant switch will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant switcher will not be displayed wit' Internet Explorer 11.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="290">2.9.0</h2>
|
||
<ul>
|
||
<li>
|
||
<p><strong>Break'n</strong>: This release removes th' themes implementat'n o' <code>ref</code>/<code>relref</code> 'n favor fer Hugos standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard complient an' exchang'n this theme 'n yer project t' some other theme will be effortless.</p>
|
||
<p>In a standard complient form ye must not link t' th' <code>*.md</code> file but t' its logical name. You’ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Non-Standard</th>
|
||
<th>Standard</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Branch bundle</td>
|
||
<td><code>basics/configuration/_index.md</code></td>
|
||
<td><code>basics/configurat'n</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Leaf bundle</td>
|
||
<td><code>basics/configuration/index.md</code></td>
|
||
<td><code>basics/configurat'n</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Plank</td>
|
||
<td><code>basics/configurat'n.md</code></td>
|
||
<td><code>basics/configurat'n</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If you’ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version">Cap'n Hugo got ye covered</a> as well.</p>
|
||
<p>Also, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugos implementat'n t' show th' error below an' abort th' generat'n. If yer project relies on this old behavior, ye can <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version">reconfigure th' error handl'n</a> o' Hugos implementat'n.</p>
|
||
<p>In th' best case yer usage o' th' old implementat'n be already standard complient an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started <code>hugo server</code> aft an upgrade an' no errors be written t' th' console.</p>
|
||
<p>Ye may see errors on th' console aft th' update 'n th' form:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">ERROR 2021/11/19 22:29:10 <span class="o">[</span>en<span class="o">]</span> REF_NOT_FOUND: Ref <span class="s2">"basics/configuration/_index.md"</span>: <span class="s2">"hugo-theme-relearn\exampleSite\content\_index.en.md:19:22"</span>: plank not found
|
||
</span></span></code></pre></div><p>In this case, ye must apply one o' two opt'ns:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Copy th' old implementat'n files <code>theme/hugo-theme-relearn/layouts/shortcode/ref.html</code> an' <code>theme/hugo-theme-relearn/layouts/shortcode/relref.html</code> t' yer own projects <code>layouts/shortcode/ref.html</code> an' <code>layouts/shortcode/relref.html</code> respectively. <strong>This be not recommended</strong> as yer project will still rely on non-standard behavior afterwards.</p>
|
||
</li>
|
||
<li>
|
||
<p>Start up a text editor wit' regular expression support fer search an' replace. Apply th' follow'n conversions 'n th' given order on all <code>*.md</code> files. <strong>This be th' recommended choice</strong>.</p>
|
||
</li>
|
||
</ol>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Type</th>
|
||
<th>Search</th>
|
||
<th>Replace by</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Branch bundle</td>
|
||
<td><code>(ref\s+"[^"]*)/_index\.md"</code></td>
|
||
<td><code>$1"</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Leaf bundle</td>
|
||
<td><code>(ref\s+"[^"]*)/index\.md"</code></td>
|
||
<td><code>$1"</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Plank</td>
|
||
<td><code>(ref\s+"[^"]*)\.md"</code></td>
|
||
<td><code>$1"</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="280">2.8.0</h2>
|
||
<ul>
|
||
<li>
|
||
<p><strong>Change</strong>: Although never officially documented, this release removes th' font <code>Novacento</code>/<code>Novecento</code>. If ye use it 'n an overwritten CSS please replace it wit' <code>Work Sans</code>. This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer czech.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Th' theme now supports favicons served from <code>static/images/</code> named as <code>favicon</code> or <code>logo</code> 'n SVG, PNG or ICO format <a href="/hugo-theme-relearn/pir/basics/customization/#change-the-favicon">out o' th' box</a>. An overridden partial <code>layouts/partials/favicon.html</code> may not be necessary anymore 'n most cases.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' <code>disableToc</code> opt'n 'n yer <code>config.toml</code>. For an example see <a href="/hugo-theme-relearn/pir/basics/configuration/#global-site-parameters">th' example configurat'n</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="270">2.7.0</h2>
|
||
<ul>
|
||
<li><strong>New</strong>: Optional second parameter fer <a href="/hugo-theme-relearn/pir/shortcodes/notice/"><code>notice</code></a> shorrrtcode t' set title 'n box header.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="260">2.6.0</h2>
|
||
<ul>
|
||
<li><strong>New</strong>: Yer ship can now be served from a subfolder if ye set <code>baseURL</code> an' <code>canonifyURLs=true</code> 'n yer <code>config.toml</code>. See th' <a href="/hugo-theme-relearn/pir/basics/configuration/#a-word-on-running-your-site-in-a-subfolder">documentat'n</a> fer a detailed example.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="250">2.5.0</h2>
|
||
<ul>
|
||
<li><strong>Change</strong>: New colors <code>--CODE-BLOCK-color</code> an' <code>--CODE-BLOCK-BG-color</code> were added t' provide a fallback fer Hugos rules highlightn'n 'n case <code>guessSyntax=true</code> be set. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="240">2.4.0</h2>
|
||
<ul>
|
||
<li>
|
||
<p><strong>Change</strong>: Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n <code>disableTagHiddenPages=true</code> 'n yer <code>config.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' <code>alwaysopen</code> opt'n 'n yer <code>config.toml</code>. Please see further <a href="/hugo-theme-relearn/pir/cont/pages/#override-expand-state-rules-for-menu-entries">documentat'n</a> fer poss'ble values an' default behavior.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: New frontmatter <code>ordersectionsby</code> opt'n t' change immediate children sort'n 'n menu an' <code>children</code> shorrrtcode. Poss'ble values be <code>title</code> or <code>weight</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See <a href="https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head">Cap'n Hugo documentat'n</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="230">2.3.0</h2>
|
||
<ul>
|
||
<li><strong>New</strong>: Showcase multilanguage features by provd'n a documentat'n translat'n “fer us pirrrates”. There will be no other translat'ns besides th' original English one an' th' Pirates one due t' maintenance constraints.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="220">2.2.0</h2>
|
||
<ul>
|
||
<li><strong>New</strong>: Hidden planks be displayed by default 'n th' sitemap generated by Cap'n Hugo an' be therefore vis'ble fer search engine index'n. Ye can now turn off this behavior by sett'n <code>disableSeoHiddenPages=true</code> 'n yer <code>config.toml</code>.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="210">2.1.0</h2>
|
||
<ul>
|
||
<li>
|
||
<p><strong>Change</strong>: In case th' site’s structure contains addional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see <code>CHANGELOG.md</code> 'n th' exampleSite), they will now be ignored by th' search.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n <code>disableSearchHiddenPages=true</code> 'n yer <code>config.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: If a search term be found 'n an <code>expand</code> shorrrtcode, th' expand will be opened.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Th' menu will scroll th' active item into view on board.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="200">2.0.0</h2>
|
||
<ul>
|
||
<li>
|
||
<p><strong>Change</strong>: Syntaxhighlightn'n was switched t' th' <a href="https://gohugo.io/content-management/syntax-highlighting/">built 'n Hugo mechanism</a>. Ye may need t' configure a new stylesheet or decide t' roll ye own as described on 'n th' Cap'n Hugo documentat'n</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Change</strong>: In th' predefined stylesheets there was a typo an' <code>--MENU-HOME-LINK-HOVERED-color</code> must be changed t' <code>--MENU-HOME-LINK-HOVER-color</code>. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Change</strong>: <code>--MENU-HOME-LINK-color</code> an' <code>--MENU-HOME-LINK-HOVER-color</code> were miss'n 'n th' documentat'n. Ye should add them t' yer custom stylesheets if ye want t' override th' defaults.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Change</strong>: Arrow navigat'n an' <code>children</code> shorrrtcode were ignor'n sett'n fer <code>ordersectionsby</code>. This be now changed an' may result 'n different sort'n order o' yer sub planks.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Change</strong>: If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Change</strong>: A plank without a <code>title</code> will be treated as <code>hidden=true</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further <a href="/hugo-theme-relearn/pir/cont/pages/#override-expand-state-rules-for-menu-entries">documentat'n</a> fer poss'ble values an' default behavior.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See <a href="/hugo-theme-relearn/pir/basics/customization/">documentat'n</a> fer further read'n.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: Shorrrtcode <a href="/hugo-theme-relearn/pir/shortcodes/children/"><code>children</code></a> wit' new parameter <code>containerstyle</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>New</strong>: New shorrrtcode <a href="/hugo-theme-relearn/pir/shortcodes/include/"><code>include</code></a> t' include arbitrary file rrrambl'n into a plank.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="120">1.2.0</h2>
|
||
<ul>
|
||
<li><strong>New</strong>: Shorrrtcode <a href="/hugo-theme-relearn/pir/shortcodes/expand/"><code>expand</code></a> wit' new parameter t' open on plank board.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="110">1.1.0</h2>
|
||
<ul>
|
||
<li><strong>New</strong>: <a href="/hugo-theme-relearn/pir/shortcodes/mermaid/#configuration"><code>Merrrmaid</code></a> config opt'ns can be set 'n <code>config.toml</code>.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="100">1.0.0</h2>
|
||
<ul>
|
||
<li><strong>New</strong>: Initial fork o' th' <a href="https://github.com/matcornic/hugo-theme-learn">Learrrn theme</a> based on Learrrn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename t' <code>Relearrrn</code> an' a new logo. For th' reasons behind fork'n th' Learrrn theme, see <a href="https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495">this comment</a> 'n th' Learrrn issues.</li>
|
||
</ul>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Configurrrat'n</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<h2 id="global-site-parameters">Global ship parameters</h2>
|
||
<p>On top o' <a href="https://gohugo.io/overview/configuration/">Cap'n Hugo global configurat'n</a>, th' Relearrrn theme lets ye define th' follow'n parameters 'n yer <code>config.toml</code> (here, values be default).</p>
|
||
<p>Avast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n.</p>
|
||
<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="c"># This controls whether submenus will be expanded (true), or collapsed (false) 'n th'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># menu; if no sett'n be given, th' first menu level be set t' false, all others t' true;</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># this can be overridden 'n th' planks frontmatter</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">alwaysopen</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Prefix URL t' edit current plank. Will display an "Edit" button on top right hand corner o' every plank.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Useful t' give opportunity t' people t' create merge request fer yer doc.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># See th' config.toml file from this documentat'n ship t' have an example.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">editURL</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Author o' th' ship, will be used 'n meta informat'n</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">author</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Descript'n o' th' ship, will be used 'n meta informat'n</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">descript'n</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Shows a checkmark fer visited planks on th' menu</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">showVisitedLinks</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Dis'ble search funct'n. It will hide search bar</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableSearch</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Dis'ble search 'n hidden planks, otherwise they will be shown 'n search box</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableSearchHiddenPages</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Disables hidden planks from show'n up 'n th' sitemap an' on Google (et all), otherwise they may be indexed by search engines</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableSeoHiddenPages</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Disables hidden planks from show'n up on th' tags plank although th' tag term will be displayed even if all planks be hidden</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableTagHiddenPages</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Javascript an' CSS cache be automatically busted when new version o' ship be generated.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Set this t' true t' dis'ble this behavior (some proxies don't handle well this optimization)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableAssetsBust'n</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Set this t' true t' dis'ble copy-to-clipboard button fer inline code.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableInlineCopyToClipBoard</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># A title fer shortcuts 'n menu be set by default. Set this t' true t' dis'ble it.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableShortcutsTitle</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># If set t' false, a Home button will appear below th' search bar on th' menu.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># It be redirect'n t' th' land'n plank o' th' current language if specified. (Default be "/")</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableLandingPageButton</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># When us'n mulitlingual website, dis'ble th' switch language button.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableLanguageSwitchingButton</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Hide breadcrumbs 'n th' header an' only show th' current plank title</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableBreadcrumb</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># If set t' true, hide t'ble o' contents menu 'n th' header o' all planks</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableToc</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># If set t' false, board th' Merrrmaid module on every plank regardless if a Merrrmaid shorrrtcode or Merrrmaid codefence be present</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableMermaid</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Specifies th' remote locat'n o' th' Merrrmaid js</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">customMermaidURL</span> <span class="p">=</span> <span class="s2">"https://unpkg.com/mermaid/dist/mermaid.min.js"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Initializat'n parameter fer Merrrmaid, see Merrrmaid documentat'n</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s2">"{ \"theme\": \"default\" }"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># If set t' false, board th' Swagger module on every plank regardless if a Swagger shorrrtcode be present</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableSwagger</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Specifies th' remote locat'n o' th' RapiDoc js</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">customSwaggerURL</span> <span class="p">=</span> <span class="s2">""</span><span class="nx">https</span><span class="err">://</span><span class="nx">unpkg</span><span class="p">.</span><span class="nx">com</span><span class="err">/</span><span class="nx">rapidoc</span><span class="err">/</span><span class="nx">dist</span><span class="err">/</span><span class="nx">rapidoc-min</span><span class="p">.</span><span class="nx">js</span><span class="s2">"
|
||
</span></span></span><span class="line"><span class="cl"><span class="s2"> # Initializat'n parameter fer Swagger, see RapiDoc documentat'n
|
||
</span></span></span><span class="line"><span class="cl"><span class="s2"> swaggerInitialize = "</span><span class="p">{</span> <span class="err">\</span><span class="s2">"theme\": \"light\" }"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Hide Next an' Previous plank buttons normally displayed full height beside rrrambl'n</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableNextPrev</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Order sections 'n menu by "weight" or "title". Default t' "weight";</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># this can be overridden 'n th' planks frontmatter</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">ordersectionsby</span> <span class="p">=</span> <span class="s2">"weight"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Change default color scheme wit' a variant one. Eg. can be "red", "blue", "green" or an array like [ "blue", "green" ].</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">themeVariant</span> <span class="p">=</span> <span class="s2">"relearn-light"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Provide a list o' custom css files t' board relative from th' `static/` folder 'n th' ship root.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">custom_css</span> <span class="p">=</span> <span class="p">[</span><span class="s2">"css/foo.css"</span><span class="p">,</span> <span class="s2">"css/bar.css"</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Change th' title separator. Default t' "::".</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">titleSeparator</span> <span class="p">=</span> <span class="s2">"-"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># If set t' true, th' menu 'n th' sidebar will be displayed 'n a collaps'ble tree view.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">collapsibleMenu</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span></code></pre></div><h2 id="a-word-on-running-your-site-in-a-subfolder">A word on runn'n yer ship 'n a subfolder</h2>
|
||
<p>Th' theme runs best if yer ship be installed 'n th' root o' yer webserver. If yer ship be served from a subfolder, eg. <code>https://example.com/mysite/</code>, ye have t' set th' follow'n lines t' yer <code>config.toml</code></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">baseURL</span> <span class="p">=</span> <span class="s2">"https://example.com/mysite/"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">canonifyURLs</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span></code></pre></div><p>Without <code>canonifyURLs=true</code> URLs 'n sublemental planks (like <code>sitemap.xml</code>, <code>rss.xml</code>) will be generated falsly while yer HTML files will still work. See <a href="https://github.com/gohugoio/hugo/issues/5226">https://github.com/gohugoio/hugo/issues/5226</a>.</p>
|
||
<h2 id="activate-search">Activate search</h2>
|
||
<p>If not already present, add th' follow lines 'n th' same <code>config.toml</code> file.</p>
|
||
<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">outputs</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">home</span> <span class="p">=</span> <span class="p">[</span><span class="s2">"HTML"</span><span class="p">,</span> <span class="s2">"RSS"</span><span class="p">,</span> <span class="s2">"JSON"</span><span class="p">]</span>
|
||
</span></span></code></pre></div><p>Relearrrn theme uses th' last improvement avail'ble 'n hugo version 20+ t' generate a json index file ready t' be consumed by lunr.js javascript search engine.</p>
|
||
<blockquote>
|
||
<p>Cap'n Hugo generate lunrjs index.json at th' root o' public folder.
|
||
When ye build th' ship wit' <code>hugo server</code>, hugo generates it internally an' o' course it doesn’t show up 'n th' filesystem</p>
|
||
</blockquote>
|
||
<h2 id="activate-print-support">Activate print support</h2>
|
||
<p>Ye can activate print support t' add th' capability t' print whole chapters or even th' complete ship. Just add th' <code>PRINT</code> output format t' yer home, section an' plank 'n yer <code>config.toml</code> as seen below:</p>
|
||
<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">outputs</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">home</span> <span class="p">=</span> <span class="p">[</span><span class="s2">"HTML"</span><span class="p">,</span> <span class="s2">"RSS"</span><span class="p">,</span> <span class="s2">"PRINT"</span><span class="p">,</span> <span class="s2">"JSON"</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="p">=</span> <span class="p">[</span><span class="s2">"HTML"</span><span class="p">,</span> <span class="s2">"RSS"</span><span class="p">,</span> <span class="s2">"PRINT"</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">plank</span> <span class="p">=</span> <span class="p">[</span><span class="s2">"HTML"</span><span class="p">,</span> <span class="s2">"RSS"</span><span class="p">,</span> <span class="s2">"PRINT"</span><span class="p">]</span>
|
||
</span></span></code></pre></div><p>This will add a little printer ay'con 'n th' top bar. It will switch th' plank t' print preview when clicked. Ye can then send this plank t' th' printer by us'n yer browser’s usual print functionality.</p>
|
||
|
||
<div class="box notices note">
|
||
<div class="box-label"><i class="fas fa-exclamation-circle fa-fw"></i> Avast</div>
|
||
<div class="box-content">
|
||
<p>While colors o' yer chosen color variant be reset t' th' theme’s light standard values fer print'n, this does not apply fer Merrrmaid diagrams an' Swagger/OpenAPI Specificat'n. Those will still use th' colors o' yer chosen color variant which may cause a non coherent look on paper.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 id="mermaid">Merrrmaid</h2>
|
||
<p>Th' Merrrmaid configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See <a href="/hugo-theme-relearn/pir/shortcodes/mermaid/">Merrrmaid</a> fer additional documentat'n.</p>
|
||
<blockquote>
|
||
<p>Example:</p>
|
||
<p>Merrrmaid be globally disabled. By default it won’t be boarded by any plank.
|
||
On plank “Architecture” ye need a class diagram. Ye can set th' Merrrmaid parameters locally t' only board mermaid on this plank (not on th' others).</p>
|
||
</blockquote>
|
||
<p>Ye also can dis'ble Merrrmaid fer specific planks while globally enabled.</p>
|
||
<h2 id="home-button-configuration">Home Button Configurat'n</h2>
|
||
<p>If th' <code>disableLandingPageButton</code> opt'n be set t' <code>false</code>, a Home button will appear
|
||
on th' left menu. It be an alternative fer click'n on th' logo. T' edit th'
|
||
appearance, ye will have t' configure two parameters fer th' defined languages:</p>
|
||
<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">Languages</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">en</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="nx">landingPageURL</span> <span class="p">=</span> <span class="s2">"/"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-home'></i> Home"</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">Languages</span><span class="p">.</span><span class="nx">pir</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="nx">landingPageURL</span> <span class="p">=</span> <span class="s2">"/pir/"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-home'></i> Arrr! Homme"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">...</span>
|
||
</span></span></code></pre></div><p>If those params be not configured fer a specific language, they will get their
|
||
default values:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">landingPageURL</span> <span class="p">=</span> <span class="s2">"/"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-home'></i> Home"</span>
|
||
</span></span></code></pre></div><p>Th' home button be go'n t' look like this:</p>
|
||
<p><img src="/hugo-theme-relearn/basics/configuration/images/home_button_defaults.png?classes=shadow&width=300px" alt="Default Home Button"></p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Customizat'n</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple <a href="https://gohugo.io/templates/partials/">partials</a></p>
|
||
<p>In <code>themes/hugo-theme-relearn/layouts/partials/</code>, ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don’t change th' code directly. Instead <a href="https://gohugo.io/themes/customizing/">follow this plank</a>. You’d create a new partial 'n th' <code>layouts/partials</code> folder o' yer local project. This partial will have th' priority.</p>
|
||
<p>This theme defines th' follow'n partials :</p>
|
||
<ul>
|
||
<li><code>header.html</code>: th' header o' th' plank. <em>Not meant t' be overwritten</em></li>
|
||
<li><code>footer.html</code>: th' footer o' th' plank.<em>Not meant t' be overwritten</em></li>
|
||
<li><code>menu.html</code>: left menu. <em>Not meant t' be overwritten</em></li>
|
||
<li><code>search.html</code>: search box. <em>Not meant t' be overwritten</em></li>
|
||
<li><code>custom-header.html</code>: custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Don’t forget t' include <code>style</code> HTML tag directive 'n yer file.</li>
|
||
<li><code>custom-footer.html</code>: custom footer 'n plank. Meant t' be overwritten when add'n Javacript. Don’t forget t' include <code>javascript</code> HTML tag directive 'n yer file.</li>
|
||
<li><code>favicon.html</code>: th' favicon</li>
|
||
<li><code>logo.html</code>: th' logo, on top left hand corner</li>
|
||
<li><code>meta.html</code>: HTML meta tags, if ye want t' change default behavior</li>
|
||
<li><code>menu-pre.html</code>: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsiblity t' take th' page’s <code>pre</code> sett'n into account.</li>
|
||
<li><code>menu-post.html</code>: side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsiblity t' take th' page’s <code>post</code> sett'n into account.</li>
|
||
<li><code>menu-footer.html</code>: footer o' th' the left menu</li>
|
||
<li><code>toc.html</code>: t'ble o' contents</li>
|
||
<li><code>rrrambl'n.html</code>: th' rrrambl'n plank itself. This can be overridden if ye wan’t t' display page’s meta data above or below th' rrrambl'n.</li>
|
||
<li><code>content-footer</code>: footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye don’t like it.</li>
|
||
</ul>
|
||
<h2 id="change-the-logo">Change th' logo</h2>
|
||
<p>Create a new file 'n <code>layouts/partials/</code> named <code>logo.html</code>. Then write any HTML ye want.
|
||
Ye could use an <code>img</code> HTML tag an' reference an image created under th' <em>static</em> folder, or ye could paste a SVG definit'n!</p>
|
||
|
||
<div class="box notices note">
|
||
<div class="box-label"><i class="fas fa-exclamation-circle fa-fw"></i> Avast</div>
|
||
<div class="box-content">
|
||
<p>Th' size o' th' logo will adapt automatically</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 id="change-the-favicon">Change th' favicon</h2>
|
||
<p>If yer favicon be a SVG, PNG or ICO, just drop off yer image 'n yer local <code>static/images/</code> folder an' name it <code>favicon.svg</code>, <code>favicon.png</code> or <code>favicon.ico</code> respectivly.</p>
|
||
<p>If no favicon file be found, th' theme will lookup th' alternative filename <code>logo</code> 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.</p>
|
||
<p>If ye need t' change this default behavior, create a new file 'n <code>layouts/partials/</code> named <code>favicon.html</code>. Then write someth'n like this:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">link</span> <span class="na">rel</span><span class="o">=</span><span class="s">"icon"</span> <span class="na">href</span><span class="o">=</span><span class="s">"/images/favicon.bmp"</span> <span class="na">type</span><span class="o">=</span><span class="s">"image/bmp"</span> <span class="p">/></span>
|
||
</span></span></code></pre></div><h2 id="theme-variant">Change th' colors</h2>
|
||
<p>Th' Relearrrn theme lets ye choose between some predefined color variants 'n light or dark mode, but feel free t' add one yourself!</p>
|
||
<p>Ye can preview th' shipped variants by chang'n them 'n th' variant selector at th' bottom o' th' menu.</p>
|
||
<h3 id="single-variant">Single variant</h3>
|
||
<p>Set th' <code>themeVariant</code> value wit' th' name o' yer theme file. That’s it!</p>
|
||
<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">themeVariant</span> <span class="p">=</span> <span class="s2">"relearn-light"</span>
|
||
</span></span></code></pre></div><p>In th' above exaple yer theme file has t' be named <code>theme-relearn-light.css</code></p>
|
||
<h3 id="multiple-variants">Multiple variants</h3>
|
||
<p>Ye can also set multiple variants. In this case, th' first variant be th' default choosen on first view an' a variant switch will be shown 'n th' menu footer.</p>
|
||
<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="c"># Change default color scheme wit' a variant one.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">themeVariant</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"relearn-light"</span><span class="p">,</span> <span class="s2">"relearn-dark"</span> <span class="p">]</span>
|
||
</span></span></code></pre></div>
|
||
<div class="box notices tip">
|
||
<div class="box-label"><i class="fas fa-lightbulb fa-fw"></i> Smarrrt Arrrse</div>
|
||
<div class="box-content">
|
||
<p>If ye want t' switch th' rules highlightn'n theme together wit' yer color variant, generate a rules highlight'n stylesheet an' configure yer installat'n <a href="https://gohugo.io/content-management/syntax-highlighting/">accord'n t' Hugo’s documentat'n</a>, an' <code>@import</code> this stylesheet 'n yer color variant stylesheet. For an example, take a look into <code>theme-relearn-light.css</code> an' <code>config.toml</code> o' th' exampleSite.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h3 id="roll-your-own">Roll yer own</h3>
|
||
<p>If ye be not happy wit' th' shipped variants ye can either copy one o' th' shipped files, edit them 'n a text editor an' configure th' <code>themeVariant</code> parameter 'n yer <code>config.toml</code> or just use th' <a href="/hugo-theme-relearn/pir/basics/generator/">interactive variant generator</a>.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Stylesheet generrrat'r</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This interactive tool may help ye t' generate yer own color variant stylesheet.</p>
|
||
<p>T' get started, first select a color variant from th' variant switch that fits ye best as a start'n point.</p>
|
||
<p>Th' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.</p>
|
||
<p>Th' arrowed lines reflects how colors be inherited thru different parts o' th' theme if th' descendent isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.</p>
|
||
<p>T' better understand this select th' <code>neon</code> variant an' modify th' differnet head'n colors. There, colors fer th' head'n <code>h2</code>, <code>h3</code> an' <code>h4</code> be explicitly set. <code>h5</code> be not set an' inherits its value from <code>h4</code>. <code>h6</code> be also not set an' inherits its value from <code>h5</code>.</p>
|
||
<p>Once you’ve changed a color, th' variant switch will show a “My custom variant” entry an' yer changes be stored 'n th' browser. Ye can change planks an' even close th' browser without los'n yer changes.</p>
|
||
<p>Once ye be satisfied, ye can download th' new variants file an' install it 'n yer ship.</p>
|
||
|
||
<div class="box notices note">
|
||
<div class="box-label"><i class="fas fa-exclamation-circle fa-fw"></i> Avast</div>
|
||
<div class="box-content">
|
||
<p>This only works 'n modern browsers.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 id="variant-generator">Variant generator</h2>
|
||
<p><a class="vardownload btn btn-default">Download color variant</a>
|
||
<a class="varreset btn btn-default">Reset variant</a></p>
|
||
<div id="vargenerator" class="mermaid" style="background-color: var(--INTERNAL-MAIN-TEXT-color);" align="center">Graph</div>
|
||
<p><a class="vardownload btn btn-default">Download color variant</a>
|
||
<a class="varreset btn btn-default">Reset variant</a></p>
|
||
<script>
|
||
variants.generator( '#vargenerator', '.vardownload', '.varreset' );
|
||
</script>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Historrry</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="include hide-first-heading">
|
||
<h1 id="changelog">Changelog</h1>
|
||
<h2 id="341-2022-04-03">3.4.1 (2022-04-03)</h2>
|
||
<h3 id="fixes">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix IE11 incompatiblities <a href="https://github.com/McShelby/hugo-theme-relearn/issues/234">#234</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="340-2022-04-03">3.4.0 (2022-04-03)</h2>
|
||
<h3 id="enhancements">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add traditional chinese <a href="https://github.com/McShelby/hugo-theme-relearn/issues/233">#233</a></li>
|
||
<li>[<strong>feature</strong>] menu: expand/collapse menu items without navigat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/231">#231</a></li>
|
||
<li>[<strong>feature</strong>] print: add opt'n t' print whole chapter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/230">#230</a></li>
|
||
<li>[<strong>feature</strong>] theme: apply user supplied rrrambl'n footer below rrrambl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/229">#229</a></li>
|
||
</ul>
|
||
<h3 id="fixes-1">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: scroll t' head'n on initial board <a href="https://github.com/McShelby/hugo-theme-relearn/issues/232">#232</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="330-2022-03-28">3.3.0 (2022-03-28)</h2>
|
||
<h3 id="enhancements-1">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: add CSS font variables <a href="https://github.com/McShelby/hugo-theme-relearn/issues/227">#227</a></li>
|
||
<li>[<strong>feature</strong>] swagger: add support fer oas/swagger documentat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/226">#226</a></li>
|
||
</ul>
|
||
<h3 id="fixes-2">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: make variant switch work on slow networks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/228">#228</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="321-2022-03-25">3.2.1 (2022-03-25)</h2>
|
||
<h3 id="fixes-3">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix minor inconsistencies <a href="https://github.com/McShelby/hugo-theme-relearn/issues/225">#225</a></li>
|
||
<li>[<strong>bug</strong>] print: show more than just th' title plank <a href="https://github.com/McShelby/hugo-theme-relearn/issues/224">#224</a></li>
|
||
<li>[<strong>bug</strong>] theme: align rrrambl'n scrollbar t' th' right on big screens <a href="https://github.com/McShelby/hugo-theme-relearn/issues/223">#223</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="320-2022-03-19">3.2.0 (2022-03-19)</h2>
|
||
<h3 id="enhancements-2">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] mermaid: support differ'n themes fer color variant switch <a href="https://github.com/McShelby/hugo-theme-relearn/issues/219">#219</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: board javascript on demand <a href="https://github.com/McShelby/hugo-theme-relearn/issues/218">#218</a></li>
|
||
</ul>
|
||
<h3 id="maintenance">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update t' 8.14.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/220">#220</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="311-2022-03-16">3.1.1 (2022-03-16)</h2>
|
||
<h3 id="enhancements-3">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] language: support fer korean <a href="https://github.com/McShelby/hugo-theme-relearn/issues/217">#217</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="310-2022-03-15">3.1.0 (2022-03-15)</h2>
|
||
<h3 id="enhancements-4">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] notice: add ay'con parameter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/212">#212</a></li>
|
||
<li>[<strong>feature</strong>] mobile: remove breadcrumb ellipsis <a href="https://github.com/McShelby/hugo-theme-relearn/issues/211">#211</a></li>
|
||
</ul>
|
||
<h3 id="fixes-4">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: make storage o' multiple Cap'n Hugo sites on same server distinct <a href="https://github.com/McShelby/hugo-theme-relearn/issues/214">#214</a></li>
|
||
<li>[<strong>bug</strong>] variant: switch breadcrumb color 'n Chrome <a href="https://github.com/McShelby/hugo-theme-relearn/issues/213">#213</a></li>
|
||
<li>[<strong>bug</strong>] mobile: improve behavior o' sidebar menu <a href="https://github.com/McShelby/hugo-theme-relearn/issues/210">#210</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="304-2022-02-24">3.0.4 (2022-02-24)</h2>
|
||
<h3 id="enhancements-5">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: improve font load'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/201">#201</a></li>
|
||
<li>[<strong>feature</strong>] variant: fix inconsistent color vari'ble nam'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/200">#200</a></li>
|
||
</ul>
|
||
<h3 id="fixes-5">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: fix occasional fail when resett'n generator <a href="https://github.com/McShelby/hugo-theme-relearn/issues/208">#208</a></li>
|
||
<li>[<strong>bug</strong>] docs: don’t move header on logo hover 'n IE11 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/207">#207</a></li>
|
||
<li>[<strong>bug</strong>] variant: avoid flash o' menu header when non default variant be active <a href="https://github.com/McShelby/hugo-theme-relearn/issues/206">#206</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix wrong HTML clos'n tag order 'n chapters <a href="https://github.com/McShelby/hugo-theme-relearn/issues/205">#205</a></li>
|
||
<li>[<strong>bug</strong>] theme: adjust breadcrumb an' title fer empty home plank titles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/202">#202</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="303-2022-02-23">3.0.3 (2022-02-23)</h2>
|
||
<h3 id="enhancements-6">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tags: show tag count 'n taxonomy list <a href="https://github.com/McShelby/hugo-theme-relearn/issues/195">#195</a></li>
|
||
</ul>
|
||
<h3 id="fixes-6">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: remove Cap'n Hugo build warning if plank be not file based <a href="https://github.com/McShelby/hugo-theme-relearn/issues/197">#197</a></li>
|
||
<li>[<strong>bug</strong>] tags: adhere t' titleSeparator <a href="https://github.com/McShelby/hugo-theme-relearn/issues/196">#196</a></li>
|
||
<li>[<strong>bug</strong>] theme: hide footer divider an' variant selector 'n IE11 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/194">#194</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="302-2022-02-23">3.0.2 (2022-02-23)</h2>
|
||
<h3 id="enhancements-7">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tags: sort by name <a href="https://github.com/McShelby/hugo-theme-relearn/issues/193">#193</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="301-2022-02-23">3.0.1 (2022-02-23)</h2>
|
||
<h3 id="enhancements-8">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] children: set containerstyle automatically accord'n t' style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/192">#192</a></li>
|
||
</ul>
|
||
<h3 id="fixes-7">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: revert fontawsome t' version 5 fer IE11 compat <a href="https://github.com/McShelby/hugo-theme-relearn/issues/191">#191</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="300-2022-02-22">3.0.0 (2022-02-22)</h2>
|
||
<h3 id="enhancements-9">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] variant: build a variant generator <a href="https://github.com/McShelby/hugo-theme-relearn/issues/188">#188</a></li>
|
||
<li>[<strong>feature</strong>] nav: only show toc if th' plank has head'ns <a href="https://github.com/McShelby/hugo-theme-relearn/issues/182">#182</a></li>
|
||
<li>[<strong>feature</strong>][<strong>break'n</strong>] theme: change default colors t' Relearrrn defaults <a href="https://github.com/McShelby/hugo-theme-relearn/issues/181">#181</a></li>
|
||
<li>[<strong>feature</strong>] variant: add a variant selector <a href="https://github.com/McShelby/hugo-theme-relearn/issues/178">#178</a></li>
|
||
<li>[<strong>feature</strong>][<strong>break'n</strong>] menu: rework footer UX <a href="https://github.com/McShelby/hugo-theme-relearn/issues/177">#177</a></li>
|
||
<li>[<strong>feature</strong>] theme: support fer dark mode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/175">#175</a></li>
|
||
<li>[<strong>feature</strong>] docs: use light rules highlightn'n theme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/174">#174</a></li>
|
||
<li>[<strong>feature</strong>] notice: tweak dull colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/173">#173</a></li>
|
||
<li>[<strong>feature</strong>] theme: rework header UX <a href="https://github.com/McShelby/hugo-theme-relearn/issues/151">#151</a></li>
|
||
</ul>
|
||
<h3 id="fixes-8">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: remove additional X 'n filled out search box 'n IE11 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/190">#190</a></li>
|
||
<li>[<strong>bug</strong>] clipboard: localize tooltips <a href="https://github.com/McShelby/hugo-theme-relearn/issues/186">#186</a></li>
|
||
<li>[<strong>bug</strong>] print: hide sidebar on Mac <a href="https://github.com/McShelby/hugo-theme-relearn/issues/183">#183</a></li>
|
||
<li>[<strong>bug</strong>] menu: fix scrollbar height <a href="https://github.com/McShelby/hugo-theme-relearn/issues/180">#180</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] search: fix color change fer ay'cons on hover <a href="https://github.com/McShelby/hugo-theme-relearn/issues/176">#176</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="296-2022-02-07">2.9.6 (2022-02-07)</h2>
|
||
<h3 id="fixes-9">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: remove debug output <a href="https://github.com/McShelby/hugo-theme-relearn/issues/171">#171</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="295-2022-02-07">2.9.5 (2022-02-07)</h2>
|
||
<h3 id="fixes-10">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: let arrow navigat'n respect ordersectionsby configurat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/170">#170</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="294-2022-02-06">2.9.4 (2022-02-06)</h2>
|
||
<h3 id="fixes-11">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] exampleSite: fix links 'n official documentat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/168">#168</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="293-2022-02-06">2.9.3 (2022-02-06)</h2>
|
||
<h3 id="fixes-12">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: invalid URL when th' shortcut be an internal link <a href="https://github.com/McShelby/hugo-theme-relearn/issues/163">#163</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="292-2021-11-26">2.9.2 (2021-11-26)</h2>
|
||
<h3 id="enhancements-10">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: add theme version info t' head <a href="https://github.com/McShelby/hugo-theme-relearn/issues/158">#158</a></li>
|
||
</ul>
|
||
<h3 id="fixes-13">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix select'n o' *.ico files as favicons <a href="https://github.com/McShelby/hugo-theme-relearn/issues/160">#160</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="291-2021-11-22">2.9.1 (2021-11-22)</h2>
|
||
<h3 id="fixes-14">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: fix significantly low performance fer collect'n o' meta info <a href="https://github.com/McShelby/hugo-theme-relearn/issues/157">#157</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="290-2021-11-19">2.9.0 (2021-11-19)</h2>
|
||
<h3 id="fixes-15">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>break'n</strong>] relref: fix inconsistent behavior <a href="https://github.com/McShelby/hugo-theme-relearn/issues/156">#156</a></li>
|
||
<li>[<strong>bug</strong>] search: make dropdown stick t' search field when scroll'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/155">#155</a></li>
|
||
<li>[<strong>bug</strong>] menu: align long text properly <a href="https://github.com/McShelby/hugo-theme-relearn/issues/154">#154</a></li>
|
||
<li>[<strong>bug</strong>] copyToClipBoard: add miss'n right border fer inline code if <code>disableInlineCopyToClipBoard=true</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/153">#153</a></li>
|
||
<li>[<strong>bug</strong>] menu: show hidden sibl'n planks reliably <a href="https://github.com/McShelby/hugo-theme-relearn/issues/152">#152</a></li>
|
||
<li>[<strong>bug</strong>] menu: br'n active item 'n sight fer large menus <a href="https://github.com/McShelby/hugo-theme-relearn/issues/149">#149</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="283-2021-11-09">2.8.3 (2021-11-09)</h2>
|
||
<h3 id="fixes-16">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: let zoom reset t' initial size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/145">#145</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: remove whitespace from big graphs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/143">#143</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="282-2021-11-08">2.8.2 (2021-11-08)</h2>
|
||
<h3 id="fixes-17">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: always board javascript t' avoid break if code fences be used <a href="https://github.com/McShelby/hugo-theme-relearn/issues/142">#142</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="281-2021-11-04">2.8.1 (2021-11-04)</h2>
|
||
<h3 id="fixes-18">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: don’t break JS 'n multilang setup if search be disabled <a href="https://github.com/McShelby/hugo-theme-relearn/issues/140">#140</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="280-2021-11-03">2.8.0 (2021-11-03)</h2>
|
||
<h3 id="enhancements-11">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] toc: make disableTOC globally avail'ble via config.toml <a href="https://github.com/McShelby/hugo-theme-relearn/issues/133">#133</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: only board javascript if necessary <a href="https://github.com/McShelby/hugo-theme-relearn/issues/95">#95</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: switch font <a href="https://github.com/McShelby/hugo-theme-relearn/issues/83">#83</a></li>
|
||
<li>[<strong>feature</strong>] theme: make favicon configur'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/2">#2</a></li>
|
||
</ul>
|
||
<h3 id="fixes-19">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: assert that window.mermaid be actually mermaid <a href="https://github.com/McShelby/hugo-theme-relearn/issues/136">#136</a></li>
|
||
<li>[<strong>bug</strong>] menu: remove usage o' Hugos UniqueID <a href="https://github.com/McShelby/hugo-theme-relearn/issues/131">#131</a></li>
|
||
<li>[<strong>bug</strong>] theme: reduce margin fer children shorrrtcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/130">#130</a></li>
|
||
<li>[<strong>bug</strong>] theme: left-align h3 'n chapters <a href="https://github.com/McShelby/hugo-theme-relearn/issues/129">#129</a></li>
|
||
<li>[<strong>bug</strong>] theme: align copy link t' clipboard <a href="https://github.com/McShelby/hugo-theme-relearn/issues/128">#128</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="270-2021-10-24">2.7.0 (2021-10-24)</h2>
|
||
<h3 id="enhancements-12">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] notice: support custom titles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/124">#124</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="260-2021-10-21">2.6.0 (2021-10-21)</h2>
|
||
<h3 id="fixes-20">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: generate correct links if theme served from subdirectory <a href="https://github.com/McShelby/hugo-theme-relearn/issues/120">#120</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="251-2021-10-12">2.5.1 (2021-10-12)</h2>
|
||
<h3 id="fixes-21">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] security: fix XSS fer malicioius image URLs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/117">#117</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="250-2021-10-08">2.5.0 (2021-10-08)</h2>
|
||
<h3 id="enhancements-13">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] rules highlight: provide default colors fer unknown languages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/113">#113</a></li>
|
||
</ul>
|
||
<h3 id="fixes-22">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] security: fix XSS fer malicioius URLs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/114">#114</a></li>
|
||
<li>[<strong>bug</strong>] menu: write correct local shortcut links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/112">#112</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="241-2021-10-07">2.4.1 (2021-10-07)</h2>
|
||
<h3 id="fixes-23">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: remove runtime styles from print <a href="https://github.com/McShelby/hugo-theme-relearn/issues/111">#111</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="240-2021-10-07">2.4.0 (2021-10-07)</h2>
|
||
<h3 id="enhancements-14">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] lang: add vietnamese translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/109">#109</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: simplify stylesheet fer color variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/107">#107</a></li>
|
||
<li>[<strong>feature</strong>] hidden planks: remove from RSS feed, JSON, taxonomy etc <a href="https://github.com/McShelby/hugo-theme-relearn/issues/102">#102</a></li>
|
||
<li>[<strong>feature</strong>] theme: announce alternative rrrambl'n 'n header <a href="https://github.com/McShelby/hugo-theme-relearn/issues/101">#101</a></li>
|
||
<li>[<strong>feature</strong>] menu: frontmatter opt'n t' change sort predicate <a href="https://github.com/McShelby/hugo-theme-relearn/issues/98">#98</a></li>
|
||
<li>[<strong>feature</strong>] menu: add default sett'n fer menu expansion <a href="https://github.com/McShelby/hugo-theme-relearn/issues/97">#97</a></li>
|
||
<li>[<strong>feature</strong>] theme: improve print style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/93">#93</a></li>
|
||
<li>[<strong>feature</strong>] theme: improve style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/92">#92</a></li>
|
||
</ul>
|
||
<h3 id="fixes-24">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] include: don’t generate additional HTML if file should be displayed “as is” <a href="https://github.com/McShelby/hugo-theme-relearn/issues/110">#110</a></li>
|
||
<li>[<strong>bug</strong>] attachments: fix broken links if multilang config be used <a href="https://github.com/McShelby/hugo-theme-relearn/issues/105">#105</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix sticky header t' remove horizontal scrollbar <a href="https://github.com/McShelby/hugo-theme-relearn/issues/82">#82</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-1">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] chore: update fontawesome <a href="https://github.com/McShelby/hugo-theme-relearn/issues/94">#94</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="232-2021-09-20">2.3.2 (2021-09-20)</h2>
|
||
<h3 id="fixes-25">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] docs: rename history pirate translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/91">#91</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="231-2021-09-20">2.3.1 (2021-09-20)</h2>
|
||
<h3 id="fixes-26">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] docs: rename english pirate translat'n t' avoid crash on render'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/90">#90</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="230-2021-09-13">2.3.0 (2021-09-13)</h2>
|
||
<h3 id="fixes-27">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix usage o' section element <a href="https://github.com/McShelby/hugo-theme-relearn/issues/88">#88</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-2">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] theme: ensure IE11 compatiblity <a href="https://github.com/McShelby/hugo-theme-relearn/issues/89">#89</a></li>
|
||
<li>[<strong>task</strong>] docs: Arrr! showcase multilang featurrre <a href="https://github.com/McShelby/hugo-theme-relearn/issues/87">#87</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="220-2021-09-09">2.2.0 (2021-09-09)</h2>
|
||
<h3 id="enhancements-15">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] sitemap: hide hidden planks from sitemap an' SEO index'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/85">#85</a></li>
|
||
</ul>
|
||
<h3 id="fixes-28">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix showVisitedLinks 'n case Cap'n Hugo be configured t' modify relative URLs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/86">#86</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-3">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] theme: switch from data-vocabulary t' schema <a href="https://github.com/McShelby/hugo-theme-relearn/issues/84">#84</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="210-2021-09-07">2.1.0 (2021-09-07)</h2>
|
||
<h3 id="enhancements-16">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] search: open expand if it contains search term <a href="https://github.com/McShelby/hugo-theme-relearn/issues/80">#80</a></li>
|
||
<li>[<strong>feature</strong>] menu: scroll active item into view <a href="https://github.com/McShelby/hugo-theme-relearn/issues/79">#79</a></li>
|
||
<li>[<strong>feature</strong>] search: dis'ble search 'n hidden planks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/76">#76</a></li>
|
||
<li>[<strong>feature</strong>] search: improve readablility o' index.json <a href="https://github.com/McShelby/hugo-theme-relearn/issues/75">#75</a></li>
|
||
<li>[<strong>feature</strong>] search: increase performance <a href="https://github.com/McShelby/hugo-theme-relearn/issues/74">#74</a></li>
|
||
<li>[<strong>feature</strong>] search: improve search context preview <a href="https://github.com/McShelby/hugo-theme-relearn/issues/73">#73</a></li>
|
||
</ul>
|
||
<h3 id="fixes-29">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] search: hide non-site rrrambl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/81">#81</a></li>
|
||
<li>[<strong>bug</strong>] menu: always hide hidden sub planks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/77">#77</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="200-2021-08-28">2.0.0 (2021-08-28)</h2>
|
||
<h3 id="enhancements-17">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tabs: enhance styl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/65">#65</a></li>
|
||
<li>[<strong>feature</strong>] theme: improve readability <a href="https://github.com/McShelby/hugo-theme-relearn/issues/64">#64</a></li>
|
||
<li>[<strong>feature</strong>] menu: show hidden planks if accessed directly <a href="https://github.com/McShelby/hugo-theme-relearn/issues/60">#60</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: treat planks without title as hidden <a href="https://github.com/McShelby/hugo-theme-relearn/issues/59">#59</a></li>
|
||
<li>[<strong>feature</strong>] search: show search results if field gains focus <a href="https://github.com/McShelby/hugo-theme-relearn/issues/58">#58</a></li>
|
||
<li>[<strong>feature</strong>] theme: add partial templates fer pre/post menu entries <a href="https://github.com/McShelby/hugo-theme-relearn/issues/56">#56</a></li>
|
||
<li>[<strong>feature</strong>] theme: make chapter archetype more read'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/55">#55</a></li>
|
||
<li>[<strong>feature</strong>] children: add parameter fer container style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/53">#53</a></li>
|
||
<li>[<strong>feature</strong>] theme: make rrrambl'n a template <a href="https://github.com/McShelby/hugo-theme-relearn/issues/50">#50</a></li>
|
||
<li>[<strong>feature</strong>] menu: control menu expansion wit' alwaysopen parameter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/49">#49</a></li>
|
||
<li>[<strong>feature</strong>] include: new shorrrtcode t' include other files <a href="https://github.com/McShelby/hugo-theme-relearn/issues/43">#43</a></li>
|
||
<li>[<strong>feature</strong>] theme: adjust print styles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/35">#35</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] code highligher: switch t' standard hugo highlighter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/32">#32</a></li>
|
||
</ul>
|
||
<h3 id="fixes-30">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] arrow-nav: default sort'n ignores ordersectionsby <a href="https://github.com/McShelby/hugo-theme-relearn/issues/63">#63</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] children: default sort'n ignores ordersectionsby <a href="https://github.com/McShelby/hugo-theme-relearn/issues/62">#62</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] arrow-nav: fix broken links on (and below) hidden planks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/61">#61</a></li>
|
||
<li>[<strong>bug</strong>] theme: remove superflous singular taxonomy from taxonomy title <a href="https://github.com/McShelby/hugo-theme-relearn/issues/46">#46</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] theme: miss'n –MENU-HOME-LINK-HOVER-color 'n documentat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/45">#45</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix home link when base URL has some path <a href="https://github.com/McShelby/hugo-theme-relearn/issues/44">#44</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-4">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] docs: include changelog 'n exampleSite <a href="https://github.com/McShelby/hugo-theme-relearn/issues/33">#33</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="120-2021-07-26">1.2.0 (2021-07-26)</h2>
|
||
<h3 id="enhancements-18">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: adjust copy-to-clipboard <a href="https://github.com/McShelby/hugo-theme-relearn/issues/29">#29</a></li>
|
||
<li>[<strong>feature</strong>] attachments: adjust style between notice boxes an' attachments <a href="https://github.com/McShelby/hugo-theme-relearn/issues/28">#28</a></li>
|
||
<li>[<strong>feature</strong>] theme: adjust blockquote contrast <a href="https://github.com/McShelby/hugo-theme-relearn/issues/27">#27</a></li>
|
||
<li>[<strong>feature</strong>] expand: add opt'n t' open on plank board <a href="https://github.com/McShelby/hugo-theme-relearn/issues/25">#25</a></li>
|
||
<li>[<strong>feature</strong>] expand: rework styl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/24">#24</a></li>
|
||
<li>[<strong>feature</strong>] attachments: sort output <a href="https://github.com/McShelby/hugo-theme-relearn/issues/23">#23</a></li>
|
||
<li>[<strong>feature</strong>] notice: make restyl'n o' notice boxes more robust <a href="https://github.com/McShelby/hugo-theme-relearn/issues/20">#20</a></li>
|
||
<li>[<strong>feature</strong>] notice: fix contrast issues <a href="https://github.com/McShelby/hugo-theme-relearn/issues/19">#19</a></li>
|
||
<li>[<strong>feature</strong>] notice: align box colors t' common standards <a href="https://github.com/McShelby/hugo-theme-relearn/issues/18">#18</a></li>
|
||
<li>[<strong>feature</strong>] notice: use distinct ay'cons fer notice box type <a href="https://github.com/McShelby/hugo-theme-relearn/issues/17">#17</a></li>
|
||
</ul>
|
||
<h3 id="fixes-31">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: support i18n fer attachment size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/21">#21</a></li>
|
||
<li>[<strong>bug</strong>] notice: support i18n fer box labels <a href="https://github.com/McShelby/hugo-theme-relearn/issues/16">#16</a></li>
|
||
<li>[<strong>bug</strong>] notice: support multiple blocks 'n one box <a href="https://github.com/McShelby/hugo-theme-relearn/issues/15">#15</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-5">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] dependency: upgrade jquery t' 3.6.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/30">#30</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="111-2021-07-04">1.1.1 (2021-07-04)</h2>
|
||
<h3 id="maintenance-6">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] theme: prepare fer new hugo theme registrat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/13">#13</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="110-2021-07-02">1.1.0 (2021-07-02)</h2>
|
||
<h3 id="enhancements-19">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] mermaid: expose opt'ns 'n config.toml <a href="https://github.com/McShelby/hugo-theme-relearn/issues/4">#4</a></li>
|
||
</ul>
|
||
<h3 id="fixes-32">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: config opt'n fer CDN url not used <a href="https://github.com/McShelby/hugo-theme-relearn/issues/12">#12</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: only highlight text 'n HTML elements <a href="https://github.com/McShelby/hugo-theme-relearn/issues/10">#10</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: support pan & zoom fer graphs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/9">#9</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: code fences not always rendered <a href="https://github.com/McShelby/hugo-theme-relearn/issues/6">#6</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: search term on board may bomb chart <a href="https://github.com/McShelby/hugo-theme-relearn/issues/5">#5</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-7">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update t' 8.10.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/7">#7</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="101-2021-07-01">1.0.1 (2021-07-01)</h2>
|
||
<h3 id="maintenance-8">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] Prepare fer hugo showcase <a href="https://github.com/McShelby/hugo-theme-relearn/issues/3">#3</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="100-2021-07-01">1.0.0 (2021-07-01)</h2>
|
||
<h3 id="maintenance-9">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] Fork project <a href="https://github.com/McShelby/hugo-theme-relearn/issues/1">#1</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
</section>
|
||
|
||
<article class="chapter">
|
||
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<h3 id="chapter-2">Chapter 2</h3>
|
||
<h1 id="content">Rrrambl'n</h1>
|
||
<p>Find out how t' create an' org'nize yer rrrambl'n quickly an' intuitively.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
<section>
|
||
|
||
<article>
|
||
|
||
<h1>Planks orrrganizat'n</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>In <strong>Cap'n Hugo</strong>, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.</p>
|
||
<h2 id="folders">Folders</h2>
|
||
<p>Org'nize yer ship like <a href="https://gohugo.io/content/organization/">any other Cap'n Hugo project</a>. Typically, ye will have a <em>rrrambl'n</em> folder wit' all yer planks.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">rrrambl'n
|
||
</span></span><span class="line"><span class="cl">├── level-one
|
||
</span></span><span class="line"><span class="cl">│ ├── level-two
|
||
</span></span><span class="line"><span class="cl">│ │ ├── level-three
|
||
</span></span><span class="line"><span class="cl">│ │ │ ├── level-four
|
||
</span></span><span class="line"><span class="cl">│ │ │ │ ├── _index.md <-- /level-one/level-two/level-three/level-four
|
||
</span></span><span class="line"><span class="cl">│ │ │ │ ├── page-4-a.md <-- /level-one/level-two/level-three/level-four/page-4-a
|
||
</span></span><span class="line"><span class="cl">│ │ │ │ ├── page-4-b.md <-- /level-one/level-two/level-three/level-four/page-4-b
|
||
</span></span><span class="line"><span class="cl">│ │ │ │ └── page-4-c.md <-- /level-one/level-two/level-three/level-four/page-4-c
|
||
</span></span><span class="line"><span class="cl">│ │ │ ├── _index.md <-- /level-one/level-two/level-three
|
||
</span></span><span class="line"><span class="cl">│ │ │ ├── page-3-a.md <-- /level-one/level-two/level-three/page-3-a
|
||
</span></span><span class="line"><span class="cl">│ │ │ ├── page-3-b.md <-- /level-one/level-two/level-three/page-3-b
|
||
</span></span><span class="line"><span class="cl">│ │ │ └── page-3-c.md <-- /level-one/level-two/level-three/page-3-c
|
||
</span></span><span class="line"><span class="cl">│ │ ├── _index.md <-- /level-one/level-two
|
||
</span></span><span class="line"><span class="cl">│ │ ├── page-2-a.md <-- /level-one/level-two/page-2-a
|
||
</span></span><span class="line"><span class="cl">│ │ ├── page-2-b.md <-- /level-one/level-two/page-2-b
|
||
</span></span><span class="line"><span class="cl">│ │ └── page-2-c.md <-- /level-one/level-two/page-2-c
|
||
</span></span><span class="line"><span class="cl">│ ├── _index.md <-- /level-one
|
||
</span></span><span class="line"><span class="cl">│ ├── page-1-a.md <-- /level-one/page-1-a
|
||
</span></span><span class="line"><span class="cl">│ ├── page-1-b.md <-- /level-one/page-1-b
|
||
</span></span><span class="line"><span class="cl">│ └── page-1-c.md <-- /level-one/page-1-c
|
||
</span></span><span class="line"><span class="cl">├── _index.md <-- /
|
||
</span></span><span class="line"><span class="cl">└── page-top.md <-- /page-top
|
||
</span></span></code></pre></div>
|
||
<div class="box notices note">
|
||
<div class="box-label"><i class="fas fa-exclamation-circle fa-fw"></i> Avast</div>
|
||
<div class="box-content">
|
||
<p><code>_index.md</code> be required 'n each folder, it’s yer “folder home page”</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 id="types">Types</h2>
|
||
<p>Th' Relearrrn theme defines two types o' planks. <em>Default</em> an' <em>Chapter</em>. Both can be used at any level o' th' documentat'n, th' only difference be'n layout display.</p>
|
||
<h3 id="chapter-style">Chapter</h3>
|
||
<p>A <strong>Chapter</strong> displays a plank meant t' be used as introduct'n fer a set o' child planks. Commonly, it contains a simple title an' a catch line t' define rrrambl'n that can be found under it.</p>
|
||
<p>Ye can define any HTML as prefix fer th' menu. In th' example below, it’s just a number but that could be an <a href="https://fortawesome.github.io/Font-Awesome/">ay'con</a>.</p>
|
||
<p><img src="/hugo-theme-relearn/cont/pages/images/pages-chapter.png?classes=shadow&width=60pc" alt="Chapter page"></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">+++
|
||
</span></span><span class="line"><span class="cl">chapter = true
|
||
</span></span><span class="line"><span class="cl">pre = "<span class="p"><</span><span class="nt">b</span><span class="p">></span>1. <span class="p"></</span><span class="nt">b</span><span class="p">></span>"
|
||
</span></span><span class="line"><span class="cl">title = "Basics"
|
||
</span></span><span class="line"><span class="cl">weight = 5
|
||
</span></span><span class="line"><span class="cl">+++
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="gu">### Chapter 1
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
||
</span></span><span class="line"><span class="cl"><span class="gh"># Basics
|
||
</span></span></span><span class="line"><span class="cl"><span class="gh"></span>
|
||
</span></span><span class="line"><span class="cl">Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.
|
||
</span></span></code></pre></div><p>T' tell th' Relearrrn theme t' consider a plank as a chapter, set <code>chapter=true</code> 'n th' Front Matter o' th' plank.</p>
|
||
<h3 id="default">Default</h3>
|
||
<p>A <strong>Default</strong> plank be any other rrrambl'n plank.</p>
|
||
<p><img src="/hugo-theme-relearn/cont/pages/images/pages-default.png?classes=shadow&width=60pc" alt="Default page"></p>
|
||
<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">title</span> <span class="p">=</span> <span class="s2">"Installation"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">15</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span></code></pre></div><p>Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n this <a href="https://gohugo.io/overview/quickstart/">great documentat'n fer beginners</a>.</p>
|
||
<h2 id="create-your-project">Create yer project</h2>
|
||
<p>Cap'n Hugo provides a <code>new</code> command t' create a new website.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new ship <new_project>
|
||
</span></span></code></pre></div><p>Th' Relearrrn theme provides <a href="/hugo-theme-relearn/pir/cont/archetypes/">archetypes</a> t' help ye create this kind o' planks.</p>
|
||
<h2 id="front-matter-configuration">Front Matter configurat'n</h2>
|
||
<p>Each Cap'n Hugo plank has t' define a <a href="https://gohugo.io/content/front-matter/">Front Matter</a> 'n <em>toml</em>, <em>yaml</em> or <em>json</em>. This ship will use <em>toml</em> 'n all cases.</p>
|
||
<p>Th' Relearrrn theme uses th' follow'n parameters on top o' Cap'n Hugo ones :</p>
|
||
<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="c"># T'ble o' contents (toc) be enabled by default. Set this parameter t' true t' dis'ble it.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Avast: Toc be always disabled fer chapter planks</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableToc</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set, this will be used fer th' page's menu entry (instead o' th' `title` attribute)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">menuTitle</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set, this will explicitly override common rules fer th' expand state o' a page's menu entry</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">alwaysopen</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set, this will explicitly override common rules fer th' sort'n order o' a page's submenu entries</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">ordersectionsby</span> <span class="p">=</span> <span class="s2">"title"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' title o' th' plank 'n menu will be prefixed by this HTML rrrambl'n</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">pre</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' title o' th' plank 'n menu will be postfixed by this HTML rrrambl'n</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">post</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Set th' plank as a chapter, chang'n th' way it's displayed</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">chapter</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide a menu entry by sett'n this t' true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">hidden</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Display name o' this plank modifier. If set, it will be displayed 'n th' footer.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">LastModifierDisplayName</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Email o' this plank modifier. If set wit' LastModifierDisplayName, it will be displayed 'n th' footer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">LastModifierEmail</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span></code></pre></div><h3 id="add-icon-to-a-menu-entry">Add ay'con t' a menu entry</h3>
|
||
<p>In th' plank frontmatter, add a <code>pre</code> param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.</p>
|
||
<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">title</span> <span class="p">=</span> <span class="s2">"GitHub repo"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">pre</span> <span class="p">=</span> <span class="s2">"<i class='fab fa-github'></i> "</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span></code></pre></div><p><img src="/hugo-theme-relearn/cont/pages/images/frontmatter-icon.png?classes=shadow&width=300px" alt="Title wit' icon"></p>
|
||
<h3 id="ordering-sibling-menupage-entries">Order'n sibl'n menu/page entries</h3>
|
||
<p>Cap'n Hugo provides a <a href="https://gohugo.io/content/ordering/">flex'ble way</a> t' handle order fer yer planks.</p>
|
||
<p>Th' simplest way be t' set <code>weight</code> parameter t' a number.</p>
|
||
<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">title</span> <span class="p">=</span> <span class="s2">"My page"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">5</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span></code></pre></div><h3 id="using-a-custom-title-for-menu-entries">Us'n a custom title fer menu entries</h3>
|
||
<p>By default, th' Relearrrn theme will use a page’s <code>title</code> attribute fer th' menu item (or <code>linkTitle</code> if defined).</p>
|
||
<p>But a page’s title has t' be descriptive on its own while th' menu be a hierarchy.
|
||
We’ve added th' <code>menuTitle</code> parameter fer that purpose:</p>
|
||
<p>For example (for a plank named <code>content/install/linux.md</code>):</p>
|
||
<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">title</span> <span class="p">=</span> <span class="s2">"Install on Linux"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">menuTitle</span> <span class="p">=</span> <span class="s2">"Linux"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span></code></pre></div><h3 id="override-expand-state-rules-for-menu-entries">Override expand state rules fer menu entries</h3>
|
||
<p>Ye can change how th' theme expands menu entries on th' side o' th' rrrambl'n wit' th' <code>alwaysopen</code> sett'n on a per plank basis. If <code>alwaysopen=false</code> fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.</p>
|
||
<p>Th' theme generates th' menu based on th' follow'n rules:</p>
|
||
<ul>
|
||
<li>all parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns</li>
|
||
<li>immediate children entries o' th' active plank be shown regardless o' any sett'ns</li>
|
||
<li>if not overridden, all other first level entries behave like they would have been given <code>alwaysopen=false</code></li>
|
||
<li>if not overridden, all other entries o' levels besides th' first behave like they would have been given <code>alwaysopen=true</code></li>
|
||
<li>all vis'ble entries show their immediate children entries if <code>alwaysopen=true</code>; this proceeds recursivley</li>
|
||
<li>all remain'n entries be not shown</li>
|
||
</ul>
|
||
<p>Ye can see this feature 'n act'n on th' example plank fer <a href="/hugo-theme-relearn/pir/shortcodes/children/">children shorrrtcode</a> an' its children planks.</p>
|
||
<h2 id="your-page">Yer Plank</h2>
|
||
<p>T' configure yer plank, ye basically have three choices:</p>
|
||
<ol>
|
||
<li>Create an <code>_index.md</code> document 'n <code>rrrambl'n</code> folder an' fill th' file wit' <em>Marrrkdown rrrambl'n</em></li>
|
||
<li>Create an <code>index.html</code> file 'n th' <code>static</code> folder an' fill th' file wit' <em>HTML rrrambl'n</em></li>
|
||
<li>Configure yer server t' automatically redirect home plank t' one yer documentat'n plank</li>
|
||
</ol>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Arrrchetypes</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Us'n th' command: <code>hugo new [relative new rrrambl'n path]</code>, ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: <a href="https://gohugo.io/content/archetypes/">archetypes</a>.</p>
|
||
<p>It be pre-configured skeleton planks wit' default front matter. Please refer t' th' documentat'n fer types o' plank t' understand th' differences.</p>
|
||
<h2 id="archetypes-chapter">Chapter</h2>
|
||
<p>T' create a Chapter plank, run th' follow'n commands</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new --kind chapter <name>/_index.md
|
||
</span></span></code></pre></div><p>It will create a plank wit' predefined Front-Matter:</p>
|
||
<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">chapter</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">pre</span> <span class="p">=</span> <span class="s2">"<b>X. </b>"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"{{ replace .Name "</span><span class="nx">-</span><span class="s2">" "</span> <span class="s2">" | title }}"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">5</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">### Chapter X</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Some Chapter title</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Lorem</span> <span class="nx">Ipsum</span><span class="p">.</span>
|
||
</span></span></code></pre></div><h2 id="default">Default</h2>
|
||
<p>T' create a default plank, run either one o' th' follow'n commands either</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new <chapter>/<name>/_index.md
|
||
</span></span></code></pre></div><p>or</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new <chapter>/<name>.md
|
||
</span></span></code></pre></div><p>It will create a plank wit' predefined Front-Matter:</p>
|
||
<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">title</span> <span class="p">=</span> <span class="s2">"{{ replace .Name "</span><span class="nx">-</span><span class="s2">" "</span> <span class="s2">" | title }}"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">5</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Lorem</span> <span class="nx">Ipsum</span><span class="p">.</span>
|
||
</span></span></code></pre></div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Marrrkdown rules</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Let’s face it: Writ'n rrrambl'n fer th' Web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.</p>
|
||
<p><strong>Marrrkdown</strong> be a better way t' write <strong>HTML</strong>, without all th' complexities an' ugliness that usually accompanies it.</p>
|
||
<p>Some o' th' key benefits be:</p>
|
||
<ol>
|
||
<li>Marrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n.</li>
|
||
<li>Less chance o' errors when writ'n 'n Marrrkdown.</li>
|
||
<li>Produces valid XHTML output.</li>
|
||
<li>Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship.</li>
|
||
<li>Write 'n any text editor or Marrrkdown applicat'n ye like.</li>
|
||
<li>Marrrkdown be a joy t' use!</li>
|
||
</ol>
|
||
<p>John Gruber, th' author o' Marrrkdown, puts it like this:</p>
|
||
<blockquote>
|
||
<p>Th' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email.
|
||
<cite>John Gruber</cite></p>
|
||
</blockquote>
|
||
<p>Without further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:</p>
|
||
|
||
<div class="box notices info">
|
||
<div class="box-label"><i class="fas fa-info-circle fa-fw"></i> Ahoi</div>
|
||
<div class="box-content">
|
||
<p><i class="fas fa-bookmark"></i> Bookmark this plank an' th' <a href="https://commonmark.org/help/">official Commonmark reference</a> fer easy future reference!</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 id="headings">Head'ns</h2>
|
||
<p>Head'ns from <code>h1</code> through <code>h6</code> be constructed wit' a <code>#</code> fer each level:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="gh"># h1 Head'n
|
||
</span></span></span><span class="line"><span class="cl"><span class="gh"></span><span class="gu">## h2 Head'n
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu">### h3 Head'n
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu">#### h4 Head'n
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu">##### h5 Head'n
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu">###### h6 Head'n
|
||
</span></span></span></code></pre></div><p>Renders t':</p>
|
||
<!-- markdownlint-dis'ble MD025 -->
|
||
<h1 id="h1-heading">h1 Head'n</h1>
|
||
<!-- markdownlint-en'ble MD025 -->
|
||
<h2 id="h2-heading">h2 Head'n</h2>
|
||
<h3 id="h3-heading">h3 Head'n</h3>
|
||
<h4 id="h4-heading">h4 Head'n</h4>
|
||
<h5 id="h5-heading">h5 Head'n</h5>
|
||
<h6 id="h6-heading">h6 Head'n</h6>
|
||
<p>HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">h1</span><span class="p">></span>h1 Head'n<span class="p"></</span><span class="nt">h1</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"><</span><span class="nt">h2</span><span class="p">></span>h2 Head'n<span class="p"></</span><span class="nt">h2</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"><</span><span class="nt">h3</span><span class="p">></span>h3 Head'n<span class="p"></</span><span class="nt">h3</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"><</span><span class="nt">h4</span><span class="p">></span>h4 Head'n<span class="p"></</span><span class="nt">h4</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"><</span><span class="nt">h5</span><span class="p">></span>h5 Head'n<span class="p"></</span><span class="nt">h5</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"><</span><span class="nt">h6</span><span class="p">></span>h6 Head'n<span class="p"></</span><span class="nt">h6</span><span class="p">></span>
|
||
</span></span></code></pre></div><h2 id="comments">Comments</h2>
|
||
<p>Comments should be HTML compat'ble</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="c"><!--
|
||
</span></span></span><span class="line"><span class="cl"><span class="c">This be a comment
|
||
</span></span></span><span class="line"><span class="cl"><span class="c">--></span>
|
||
</span></span></code></pre></div><p>Comment below should <strong>NOT</strong> be seen:</p>
|
||
<!--
|
||
This be a comment
|
||
-->
|
||
<h2 id="horizontal-rules">Horizontal Rules</h2>
|
||
<p>Th' HTML <code><hr></code> element be fer creat'n a “thematic break” between paragraph-level elements. In Marrrkdown, ye can create a <code><hr></code> wit' <code>---</code> - three consecutive dashes</p>
|
||
<p>renders t':</p>
|
||
<hr>
|
||
<h2 id="paragraphs">Paragraphs</h2>
|
||
<p>Any text not start'n wit' a special sign be written as normal, plain text an' will be wrapped within <code><p></p></code> tags 'n th' rendered HTML.</p>
|
||
<p>So this body copy:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
||
</span></span></code></pre></div><p>renders t' this HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">p</span><span class="p">></span>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.<span class="p"></</span><span class="nt">p</span><span class="p">></span>
|
||
</span></span></code></pre></div><h2 id="text-markers">Text Markers</h2>
|
||
<h3 id="bold">Bold</h3>
|
||
<p>For emphasiz'n a snippet o' text wit' a heavier font-weight.</p>
|
||
<p>Th' follow'n snippet o' text be <strong>rendered as bold text</strong>.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">**rendered as bold text**
|
||
</span></span></code></pre></div><p>renders t':</p>
|
||
<!-- markdownlint-dis'ble MD036 -->
|
||
<p><strong>rendered as bold text</strong></p>
|
||
<!-- markdownlint-en'ble MD036 -->
|
||
<p>an' this HTML</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">strong</span><span class="p">></span>rendered as bold text<span class="p"></</span><span class="nt">strong</span><span class="p">></span>
|
||
</span></span></code></pre></div><h3 id="italics">Italics</h3>
|
||
<p>For emphasiz'n a snippet o' text wit' italics.</p>
|
||
<p>Th' follow'n snippet o' text be <em>rendered as italicized text</em>.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">_rendered as italicized text_
|
||
</span></span></code></pre></div><p>renders t':</p>
|
||
<!-- markdownlint-dis'ble MD036 -->
|
||
<p><em>rendered as italicized text</em></p>
|
||
<!-- markdownlint-en'ble MD036 -->
|
||
<p>an' this HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">em</span><span class="p">></span>rendered as italicized text<span class="p"></</span><span class="nt">em</span><span class="p">></span>
|
||
</span></span></code></pre></div><h3 id="strikethrough">Strikethrough</h3>
|
||
<p>In GFM (GitHub flavored Markdown) ye can do strikethroughs.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">~~Strike through this text.~~
|
||
</span></span></code></pre></div><p>Which renders t':</p>
|
||
<p><del>Strike through this text.</del></p>
|
||
<p>HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">del</span><span class="p">></span>Strike through this text.<span class="p"></</span><span class="nt">del</span><span class="p">></span>
|
||
</span></span></code></pre></div><h2 id="blockquotes">Blockquotes</h2>
|
||
<p>For quot'n blocks o' rrrambl'n from another source within yer document.</p>
|
||
<p>Add <code>></code> before any text ye want t' quote.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">> </span><span class="ge">**Fusion Drive** combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.
|
||
</span></span></span></code></pre></div><p>Renders t':</p>
|
||
<blockquote>
|
||
<p><strong>Fusion Drive</strong> combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.</p>
|
||
</blockquote>
|
||
<p>an' this HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">blockquote</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">p</span><span class="p">><</span><span class="nt">strong</span><span class="p">></span>Fusion Drive<span class="p"></</span><span class="nt">strong</span><span class="p">></span> combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.<span class="p"></</span><span class="nt">p</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"></</span><span class="nt">blockquote</span><span class="p">></span>
|
||
</span></span></code></pre></div><p>Blockquotes can also be nested:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">> </span><span class="ge">Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
||
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">>
|
||
</span></span></span><span class="line"><span class="cl"><span class="k"></span><span class="ge">> > Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.
|
||
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">>
|
||
</span></span></span><span class="line"><span class="cl"><span class="k"></span><span class="ge">> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
|
||
</span></span></span></code></pre></div><p>Renders t':</p>
|
||
<blockquote>
|
||
<p>Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.</p>
|
||
<blockquote>
|
||
<p>Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.</p>
|
||
</blockquote>
|
||
<p>Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</p>
|
||
</blockquote>
|
||
<h2 id="lists">Lists</h2>
|
||
<h3 id="unordered">Unordered</h3>
|
||
<p>A list o' items 'n which th' order o' th' items does not explicitly matter.</p>
|
||
<p>Ye may use any o' th' follow'n symbols t' denote bullets fer each list item:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">*</span> valid bullet
|
||
</span></span><span class="line"><span class="cl"><span class="k">-</span> valid bullet
|
||
</span></span><span class="line"><span class="cl">+ valid bullet
|
||
</span></span></code></pre></div><p>For example</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">+ Lorem ipsum dolor sit amet
|
||
</span></span><span class="line"><span class="cl">+ Consectetur adipisc'n elit
|
||
</span></span><span class="line"><span class="cl">+ Integer molestie lorem at massa
|
||
</span></span><span class="line"><span class="cl">+ Facilisis 'n pretium nisl aliquet
|
||
</span></span><span class="line"><span class="cl">+ Nulla volutpat aliquam velit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Phasellus iaculis neque
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Purus sodales ultricies
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Vestibulum laoreet porttitor sem
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Ac tristique libero volutpat at
|
||
</span></span><span class="line"><span class="cl">+ Faucibus porta lacus fringilla vel
|
||
</span></span><span class="line"><span class="cl">+ Aenean sit amet erat nunc
|
||
</span></span><span class="line"><span class="cl">+ Eget porttitor lorem
|
||
</span></span></code></pre></div><p>Renders t':</p>
|
||
<!-- markdownlint-dis'ble MD004 -->
|
||
<ul>
|
||
<li>Lorem ipsum dolor sit amet</li>
|
||
<li>Consectetur adipisc'n elit</li>
|
||
<li>Integer molestie lorem at massa</li>
|
||
<li>Facilisis 'n pretium nisl aliquet</li>
|
||
<li>Nulla volutpat aliquam velit
|
||
<ul>
|
||
<li>Phasellus iaculis neque</li>
|
||
<li>Purus sodales ultricies</li>
|
||
<li>Vestibulum laoreet porttitor sem</li>
|
||
<li>Ac tristique libero volutpat at</li>
|
||
</ul>
|
||
</li>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
<li>Aenean sit amet erat nunc</li>
|
||
<li>Eget porttitor lorem</li>
|
||
</ul>
|
||
<!-- markdownlint-en'ble MD004 -->
|
||
<p>An' this HTML</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">ul</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Lorem ipsum dolor sit amet<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Consectetur adipisc'n elit<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Integer molestie lorem at massa<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Facilisis 'n pretium nisl aliquet<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Nulla volutpat aliquam velit
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">ul</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Phasellus iaculis neque<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Purus sodales ultricies<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Vestibulum laoreet porttitor sem<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Ac tristique libero volutpat at<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"></</span><span class="nt">ul</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Faucibus porta lacus fringilla vel<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Aenean sit amet erat nunc<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Eget porttitor lorem<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"></</span><span class="nt">ul</span><span class="p">></span>
|
||
</span></span></code></pre></div><h3 id="ordered">Ordered</h3>
|
||
<p>A list o' items 'n which th' order o' items does explicitly matter.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">1.</span> Lorem ipsum dolor sit amet
|
||
</span></span><span class="line"><span class="cl"><span class="k">4.</span> Consectetur adipisc'n elit
|
||
</span></span><span class="line"><span class="cl"><span class="k">2.</span> Integer molestie lorem at massa
|
||
</span></span><span class="line"><span class="cl"><span class="k">8.</span> Facilisis 'n pretium nisl aliquet
|
||
</span></span><span class="line"><span class="cl"><span class="k">4.</span> Nulla volutpat aliquam velit
|
||
</span></span><span class="line"><span class="cl"><span class="k">99.</span> Faucibus porta lacus fringilla vel
|
||
</span></span><span class="line"><span class="cl"><span class="k">21.</span> Aenean sit amet erat nunc
|
||
</span></span><span class="line"><span class="cl"><span class="k">6.</span> Eget porttitor lorem
|
||
</span></span></code></pre></div><p>Renders t':</p>
|
||
<ol>
|
||
<li>Lorem ipsum dolor sit amet</li>
|
||
<li>Consectetur adipisc'n elit</li>
|
||
<li>Integer molestie lorem at massa</li>
|
||
<li>Facilisis 'n pretium nisl aliquet</li>
|
||
<li>Nulla volutpat aliquam velit</li>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
<li>Aenean sit amet erat nunc</li>
|
||
<li>Eget porttitor lorem</li>
|
||
</ol>
|
||
<p>An' this HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">ol</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Lorem ipsum dolor sit amet<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Consectetur adipisc'n elit<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Integer molestie lorem at massa<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Facilisis 'n pretium nisl aliquet<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Nulla volutpat aliquam velit<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Faucibus porta lacus fringilla vel<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Aenean sit amet erat nunc<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">li</span><span class="p">></span>Eget porttitor lorem<span class="p"></</span><span class="nt">li</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"></</span><span class="nt">ol</span><span class="p">></span>
|
||
</span></span></code></pre></div>
|
||
<div class="box notices tip">
|
||
<div class="box-label"><i class="fas fa-lightbulb fa-fw"></i> Smarrrt Arrrse</div>
|
||
<div class="box-content">
|
||
<p>If ye just use <code>1.</code> fer each number, Marrrkdown will automatically number each item. For example:</p>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">1.</span> Lorem ipsum dolor sit amet
|
||
</span></span><span class="line"><span class="cl"><span class="k">1.</span> Consectetur adipisc'n elit
|
||
</span></span><span class="line"><span class="cl"><span class="k">1.</span> Integer molestie lorem at massa
|
||
</span></span><span class="line"><span class="cl"><span class="k">1.</span> Facilisis 'n pretium nisl aliquet
|
||
</span></span><span class="line"><span class="cl"><span class="k">1.</span> Nulla volutpat aliquam velit
|
||
</span></span><span class="line"><span class="cl"><span class="k">1.</span> Faucibus porta lacus fringilla vel
|
||
</span></span><span class="line"><span class="cl"><span class="k">1.</span> Aenean sit amet erat nunc
|
||
</span></span><span class="line"><span class="cl"><span class="k">1.</span> Eget porttitor lorem
|
||
</span></span></code></pre></div><p>Renders t':</p>
|
||
<ol>
|
||
<li>Lorem ipsum dolor sit amet</li>
|
||
<li>Consectetur adipisc'n elit</li>
|
||
<li>Integer molestie lorem at massa</li>
|
||
<li>Facilisis 'n pretium nisl aliquet</li>
|
||
<li>Nulla volutpat aliquam velit</li>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
<li>Aenean sit amet erat nunc</li>
|
||
<li>Eget porttitor lorem</li>
|
||
</ol>
|
||
<h2 id="code">Code</h2>
|
||
<h3 id="inline-code">Inline code</h3>
|
||
<p>Wrap inline snippets o' code wit' <code>`</code>.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">In this example, <span class="sb">`<div></div>`</span> should be wrapped as <span class="gs">**code**</span>.
|
||
</span></span></code></pre></div><p>Renders t':</p>
|
||
<p>In this example, <code><div></div></code> should be wrapped as <strong>code</strong>.</p>
|
||
<p>HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">p</span><span class="p">></span>In this example, <span class="p"><</span><span class="nt">code</span><span class="p">></span><span class="ni">&lt;</span>div<span class="ni">&gt;&lt;</span>/div<span class="ni">&gt;</span><span class="p"></</span><span class="nt">code</span><span class="p">></span> should be wrapped as <span class="p"><</span><span class="nt">strong</span><span class="p">></span>code<span class="p"></</span><span class="nt">strong</span><span class="p">></span>.<span class="p"></</span><span class="nt">p</span><span class="p">></span>
|
||
</span></span></code></pre></div><h3 id="indented-code">Indented code</h3>
|
||
<p>Or indent several lines o' code by at least two spaces, as 'n:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"> // Some comments
|
||
</span></span><span class="line"><span class="cl"> line 1 o' code
|
||
</span></span><span class="line"><span class="cl"> line 2 o' code
|
||
</span></span><span class="line"><span class="cl"> line 3 o' code
|
||
</span></span></code></pre></div><p>Renders t':</p>
|
||
<!-- markdownlint-dis'ble MD046 -->
|
||
<pre><code>// Some comments
|
||
line 1 o' code
|
||
line 2 o' code
|
||
line 3 o' code
|
||
</code></pre>
|
||
<!-- markdownlint-en'ble MD046 -->
|
||
<p>HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">pre</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">code</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> // Some comments
|
||
</span></span><span class="line"><span class="cl"> line 1 o' code
|
||
</span></span><span class="line"><span class="cl"> line 2 o' code
|
||
</span></span><span class="line"><span class="cl"> line 3 o' code
|
||
</span></span><span class="line"><span class="cl"> <span class="p"></</span><span class="nt">code</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"></</span><span class="nt">pre</span><span class="p">></span>
|
||
</span></span></code></pre></div><h3 id="block-code-fences">Block code “fences”</h3>
|
||
<p>Use “fences” <code>```</code> t' block 'n multiple lines o' code.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">```
|
||
</span></span><span class="line"><span class="cl">Sample text here...
|
||
</span></span><span class="line"><span class="cl">```
|
||
</span></span></code></pre></div><p>HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">pre</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">code</span><span class="p">></span>Sample text here...<span class="p"></</span><span class="nt">code</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"></</span><span class="nt">pre</span><span class="p">></span>
|
||
</span></span></code></pre></div><h3 id="syntax-highlighting">Rules highlight'n</h3>
|
||
<p>GFM, or “GitHub Flavored Markdown” also supports rules highlight'n. T' activate it, usually ye simply add th' file extension o' th' language ye want t' use directly aft th' first code “fence”, <code>```js</code>, an' rules highlight'n will automatically be applied 'n th' rendered HTML.</p>
|
||
<p>See <a href="/hugo-theme-relearn/pir/cont/syntaxhighlight/">Code Highlight'n</a> fer additional documentat'n.</p>
|
||
<p>For example, t' apply rules highlight'n t' JavaScript code:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">```js
|
||
</span></span><span class="line"><span class="cl">grunt.initConfig({
|
||
</span></span><span class="line"><span class="cl"> assemble: {
|
||
</span></span><span class="line"><span class="cl"> opt'ns: {
|
||
</span></span><span class="line"><span class="cl"> assets: 'docs/assets',
|
||
</span></span><span class="line"><span class="cl"> data: 'src/data/*.{json,yml}',
|
||
</span></span><span class="line"><span class="cl"> helpers: 'src/custom-helpers.js',
|
||
</span></span><span class="line"><span class="cl"> partials: ['src/partials/**/*.{hbs,md}']
|
||
</span></span><span class="line"><span class="cl"> },
|
||
</span></span><span class="line"><span class="cl"> planks: {
|
||
</span></span><span class="line"><span class="cl"> opt'ns: {
|
||
</span></span><span class="line"><span class="cl"> layout: 'default.hbs'
|
||
</span></span><span class="line"><span class="cl"> },
|
||
</span></span><span class="line"><span class="cl"> files: {
|
||
</span></span><span class="line"><span class="cl"> './': ['src/templates/pages/index.hbs']
|
||
</span></span><span class="line"><span class="cl"> }
|
||
</span></span><span class="line"><span class="cl"> }
|
||
</span></span><span class="line"><span class="cl"> }
|
||
</span></span><span class="line"><span class="cl">};
|
||
</span></span><span class="line"><span class="cl">```
|
||
</span></span></code></pre></div><p>Renders t':</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="nx">grunt</span><span class="p">.</span><span class="nx">initConfig</span><span class="p">({</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">assemble</span><span class="o">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">opt'ns</span><span class="o">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">assets</span><span class="o">:</span> <span class="s1">'docs/assets'</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">data</span><span class="o">:</span> <span class="s1">'src/data/*.{json,yml}'</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">helpers</span><span class="o">:</span> <span class="s1">'src/custom-helpers.js'</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">partials</span><span class="o">:</span> <span class="p">[</span><span class="s1">'src/partials/**/*.{hbs,md}'</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="nx">planks</span><span class="o">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">opt'ns</span><span class="o">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">layout</span><span class="o">:</span> <span class="s1">'default.hbs'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">files</span><span class="o">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s1">'./'</span><span class="o">:</span> <span class="p">[</span><span class="s1">'src/templates/pages/index.hbs'</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><span class="line"><span class="cl"><span class="p">};</span>
|
||
</span></span></code></pre></div><h2 id="tables">Tables</h2>
|
||
<p>Tables be created by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">| Opt'n | Descript'n |
|
||
</span></span><span class="line"><span class="cl">| ------ | ----------- |
|
||
</span></span><span class="line"><span class="cl">| data | path t' data files t' supply th' data that will be passed into templates. |
|
||
</span></span><span class="line"><span class="cl">| engine | engine t' be used fer process'n templates. Handlebars be th' default. |
|
||
</span></span><span class="line"><span class="cl">| ext | extension t' be used fer dest files. |
|
||
</span></span></code></pre></div><p>Renders t':</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Opt'n</th>
|
||
<th>Descript'n</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>data</td>
|
||
<td>path t' data files t' supply th' data that will be passed into templates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>engine</td>
|
||
<td>engine t' be used fer process'n templates. Handlebars be th' default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ext</td>
|
||
<td>extension t' be used fer dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>An' this HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">t'ble</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">tr</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">th</span><span class="p">></span>Opt'n<span class="p"></</span><span class="nt">th</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">th</span><span class="p">></span>Descript'n<span class="p"></</span><span class="nt">th</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"></</span><span class="nt">tr</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">tr</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">td</span><span class="p">></span>data<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">td</span><span class="p">></span>path t' data files t' supply th' data that will be passed into templates.<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"></</span><span class="nt">tr</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">tr</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">td</span><span class="p">></span>engine<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">td</span><span class="p">></span>engine t' be used fer process'n templates. Handlebars be th' default.<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"></</span><span class="nt">tr</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">tr</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">td</span><span class="p">></span>ext<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">td</span><span class="p">></span>extension t' be used fer dest files.<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"></</span><span class="nt">tr</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"><span class="p"></</span><span class="nt">t'ble</span><span class="p">></span>
|
||
</span></span></code></pre></div><h3 id="right-aligned-text">Right aligned text</h3>
|
||
<p>Add'n a colon on th' right side o' th' dashes below any head'n will right align text fer that column.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">| Opt'n | Descript'n |
|
||
</span></span><span class="line"><span class="cl">| ------:| -----------:|
|
||
</span></span><span class="line"><span class="cl">| data | path t' data files t' supply th' data that will be passed into templates. |
|
||
</span></span><span class="line"><span class="cl">| engine | engine t' be used fer process'n templates. Handlebars be th' default. |
|
||
</span></span><span class="line"><span class="cl">| ext | extension t' be used fer dest files. |
|
||
</span></span></code></pre></div><table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:right">Opt'n</th>
|
||
<th style="text-align:right">Descript'n</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:right">data</td>
|
||
<td style="text-align:right">path t' data files t' supply th' data that will be passed into templates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:right">engine</td>
|
||
<td style="text-align:right">engine t' be used fer process'n templates. Handlebars be th' default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:right">ext</td>
|
||
<td style="text-align:right">extension t' be used fer dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="two-tables-adjacent">Two tables adjacent</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Opt'n</th>
|
||
<th>Descript'n</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>ext</td>
|
||
<td>extension t' be used fer dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Opt'n</th>
|
||
<th>Descript'n</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>ext</td>
|
||
<td>extension t' be used fer dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="links">Links</h2>
|
||
<h3 id="basic-link">Basic link</h3>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">[<span class="nt">Assemble</span>](<span class="na">http://assemble.io</span>)
|
||
</span></span></code></pre></div><p>Renders t' (hover over th' link, there be no tooltip):</p>
|
||
<p><a href="http://assemble.io">Assemble</a></p>
|
||
<p>HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">a</span> <span class="na">href</span><span class="o">=</span><span class="s">"http://assemble.io"</span><span class="p">></span>Assemble<span class="p"></</span><span class="nt">a</span><span class="p">></span>
|
||
</span></span></code></pre></div><h3 id="add-a-tooltip">Add a tooltip</h3>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">[<span class="nt">Upstage</span>](<span class="na">https://github.com/upstage/ "Visit Upstage!"</span>)
|
||
</span></span></code></pre></div><p>Renders t' (hover over th' link, there should be a tooltip):</p>
|
||
<p><a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a></p>
|
||
<p>HTML:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">a</span> <span class="na">href</span><span class="o">=</span><span class="s">"https://github.com/upstage/"</span> <span class="na">title</span><span class="o">=</span><span class="s">"Visit Upstage!"</span><span class="p">></span>Upstage<span class="p"></</span><span class="nt">a</span><span class="p">></span>
|
||
</span></span></code></pre></div><h3 id="named-anchors">Named Anchors</h3>
|
||
<p>Named anchors en'ble ye t' jump t' th' specified anchor point on th' same plank. For example, each o' these chapters:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="gh"># T'ble o' Contents
|
||
</span></span></span><span class="line"><span class="cl"><span class="gh"></span> <span class="k">*</span> [<span class="nt">Chapter 1</span>](<span class="na">#chapter-1</span>)
|
||
</span></span><span class="line"><span class="cl"> <span class="k">*</span> [<span class="nt">Chapter 2</span>](<span class="na">#chapter-2</span>)
|
||
</span></span><span class="line"><span class="cl"> <span class="k">*</span> [<span class="nt">Chapter 3</span>](<span class="na">#chapter-3</span>)
|
||
</span></span></code></pre></div><p>will jump t' these sections:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="gu">## Chapter 1 <a id="chapter-1"></a>
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>Rrrambl'n fer chapter one.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="gu">## Chapter 2 <a id="chapter-2"></a>
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>Rrrambl'n fer chapter one.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="gu">## Chapter 3 <a id="chapter-3"></a>
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>Rrrambl'n fer chapter one.
|
||
</span></span></code></pre></div><p><strong>NOTE</strong> that specific placement o' th' anchor tag seems t' be arbitrary. They be placed inline here since it seems t' be unobtrusive, an' it works.</p>
|
||
<h2 id="images">Images</h2>
|
||
<p>Images have a similar rules t' links but include a preced'n exclamat'n point.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png</span>)
|
||
</span></span></code></pre></div><p><img src="https://octodex.github.com/images/minion.png" alt="Minion"></p>
|
||
<p>or</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Alt text</span>](<span class="na">https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat"</span>)
|
||
</span></span></code></pre></div><p><img src="https://octodex.github.com/images/stormtroopocat.jpg" alt="Alt text" title="The Stormtroopocat"></p>
|
||
<p>Like links, Images also have a footnote style rules</p>
|
||
<h3 id="alternative-usage--note-images">Alternative usage : note images</h3>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![Alt text][id]
|
||
</span></span></code></pre></div><p><img src="https://octodex.github.com/images/dojocat.jpg" alt="Alt text" title="The Dojocat"></p>
|
||
<p>Wit' a reference later 'n th' document defin'n th' URL locat'n:</p>
|
||
<pre><code>[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
||
</code></pre>
|
||
<h3 id="further-image-formatting">Further image formatt'n</h3>
|
||
<p>Th' Cap'n Hugo Marrrkdown parser supports additional non-standard functionality.</p>
|
||
<h4 id="resizing-image">Resiz'n image</h4>
|
||
<p>Add HTTP parameters <code>width</code> and/or <code>height</code> t' th' link image t' resize th' image. Values be CSS values (default be <code>auto</code>).</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?width=20pc</span>)
|
||
</span></span></code></pre></div><p><img src="https://octodex.github.com/images/minion.png?width=20pc" alt="Minion"></p>
|
||
<p><img src="https://octodex.github.com/images/stormtroopocat.png?width=20pc" alt="stormtroopocat"></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?height=50px</span>)
|
||
</span></span></code></pre></div><p><img src="https://octodex.github.com/images/minion.png?height=50px" alt="Minion"></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?height=50px&width=300px</span>)
|
||
</span></span></code></pre></div><p><img src="https://octodex.github.com/images/minion.png?height=50px&width=300px" alt="Minion"></p>
|
||
<h4 id="add-css-classes">Add CSS classes</h4>
|
||
<p>Add a HTTP <code>classes</code> parameter t' th' link image t' add CSS classes. <code>shadow</code>an' <code>border</code> be avail'ble but ye could define other ones.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">stormtroopocat</span>](<span class="na">https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow</span>)
|
||
</span></span></code></pre></div><p><img src="https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=shadow" alt="stormtroopocat"></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">stormtroopocat</span>](<span class="na">https://octodex.github.com/images/stormtroopocat.jpg?classes=border</span>)
|
||
</span></span></code></pre></div><p><img src="https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border" alt="stormtroopocat"></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">stormtroopocat</span>](<span class="na">https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow</span>)
|
||
</span></span></code></pre></div><p><img src="https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border,shadow" alt="stormtroopocat"></p>
|
||
<h4 id="lightbox">Lightbox</h4>
|
||
<p>Add a HTTP <code>featherlight</code> parameter t' th' link image t' dis'ble lightbox. By default lightbox be enabled us'n th' featherlight.js plugin. Ye can dis'ble this by defin'n <code>featherlight</code> t' <code>false</code>.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?featherlight=false</span>)
|
||
</span></span></code></pre></div><p><img src="https://octodex.github.com/images/minion.png?featherlight=false" alt="Minion"></p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Code highlight'n</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' Relearrrn theme uses <a href="https://gohugo.io/content-management/syntax-highlighting/">Hugo’s built-in rules highlight'n</a> fer code.</p>
|
||
<h2 id="markdown-syntax">Marrrkdown rules</h2>
|
||
<p>Wrap th' code block wit' three backticks an' th' name o' th' language. Highlight will try t' auto detect th' language if one be not provided.</p>
|
||
<!-- markdownlint-dis'ble MD046 -->
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">```json
|
||
</span></span><span class="line"><span class="cl">[
|
||
</span></span><span class="line"><span class="cl"> {
|
||
</span></span><span class="line"><span class="cl"> "title": "apples",
|
||
</span></span><span class="line"><span class="cl"> "count": [12000, 20000],
|
||
</span></span><span class="line"><span class="cl"> "description": {"text": "...", "sensitive": false}
|
||
</span></span><span class="line"><span class="cl"> },
|
||
</span></span><span class="line"><span class="cl"> {
|
||
</span></span><span class="line"><span class="cl"> "title": "oranges",
|
||
</span></span><span class="line"><span class="cl"> "count": [17500, null],
|
||
</span></span><span class="line"><span class="cl"> "description": {"text": "...", "sensitive": false}
|
||
</span></span><span class="line"><span class="cl"> }
|
||
</span></span><span class="line"><span class="cl">]
|
||
</span></span><span class="line"><span class="cl">```
|
||
</span></span></code></pre></div><!-- markdownlint-dis'ble MD046 -->
|
||
<p>Renders t':</p>
|
||
<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="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"title"</span><span class="p">:</span> <span class="s2">"apples"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"count"</span><span class="p">:</span> <span class="p">[</span><span class="mi">12000</span><span class="p">,</span> <span class="mi">20000</span><span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"description"</span><span class="p">:</span> <span class="p">{</span><span class="nt">"text"</span><span class="p">:</span> <span class="s2">"..."</span><span class="p">,</span> <span class="nt">"sensitive"</span><span class="p">:</span> <span class="kc">false</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="nt">"title"</span><span class="p">:</span> <span class="s2">"oranges"</span><span class="p">,</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"count"</span><span class="p">:</span> <span class="p">[</span><span class="mi">17500</span><span class="p">,</span> <span class="kc">null</span><span class="p">],</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"description"</span><span class="p">:</span> <span class="p">{</span><span class="nt">"text"</span><span class="p">:</span> <span class="s2">"..."</span><span class="p">,</span> <span class="nt">"sensitive"</span><span class="p">:</span> <span class="kc">false</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></code></pre></div><h2 id="supported-languages">Supported languages</h2>
|
||
<p>Cap'n Hugo comes wit' a <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages">remark'ble list</a> o' supported languages.</p>
|
||
<h2 id="recommended-configuration">Recommended configurat'n</h2>
|
||
<p>Ye can choose a color theme from th' <a href="https://xyproto.github.io/splash/docs/all.html">list o' supported themes</a> an' add it 'n yer <code>config.toml</code></p>
|
||
<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">marrrkup</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">marrrkup</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 set t' `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 code fences will not work anymore! So this be a mandatory</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># sett'n fer yer ship</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><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># choose a color theme or create yer own</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">style</span> <span class="p">=</span> <span class="s2">"base16-snazzy"</span>
|
||
</span></span></code></pre></div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Menu extrrra shorrrtcuts</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.</p>
|
||
<h2 id="basic-configuration">Basic configurat'n</h2>
|
||
<p>Edit th' website configurat'n <code>config.toml</code> an' add a <code>[[menu.shortcuts]]</code> entry fer each link yer want t' add.</p>
|
||
<p>Example from th' current website:</p>
|
||
<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">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fab fa-fw fa-github'></i> GitHub repo"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"ds"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">url</span> <span class="p">=</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">10</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-camera'></i> Showcases"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">url</span> <span class="p">=</span> <span class="s2">"more/showcase/"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">11</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentation"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"hugodoc"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">url</span> <span class="p">=</span> <span class="s2">"https://gohugo.io/"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">20</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-bullhorn'></i> Credits"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">url</span> <span class="p">=</span> <span class="s2">"more/credits/"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">30</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[[</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-tags'></i> Tags"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">url</span> <span class="p">=</span> <span class="s2">"tags/"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">40</span>
|
||
</span></span></code></pre></div><p>By default, shortcuts be preceded by a title. This title can be disabled by sett'n <code>disableShortcutsTitle=true</code>.
|
||
However, if ye want t' keep th' title but change its value, it can be overriden by chang'n yer local i18n translat'n str'n configurat'n.</p>
|
||
<p>For example, 'n yer local <code>i18n/en.toml</code> file, add th' follow'n rrrambl'n</p>
|
||
<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">Shortcuts-Title</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">other</span> <span class="p">=</span> <span class="s2">"<Your value>"</span>
|
||
</span></span></code></pre></div><p>Read more about <a href="https://gohugo.io/extras/menus/">hugo menu</a> an' <a href="https://gohugo.io/content-management/multilingual/#translation-of-strings">hugo i18n translat'n str'ns</a></p>
|
||
<h2 id="i18n">Configurat'n fer Multilingual mode</h2>
|
||
<p>When us'n a multilingual website, ye can set different menus fer each language. In th' <code>config.toml</code> file, prefix yer menu configurat'n by <code>Languages.<language-id></code>.</p>
|
||
<p>Example from th' current website:</p>
|
||
<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">Languages</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">en</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="p">=</span> <span class="s2">"Hugo Relearrrn Theme"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">languageName</span> <span class="p">=</span> <span class="s2">"English"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">landingPageURL</span> <span class="p">=</span> <span class="s2">"/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-home'></i> Home"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fab fa-fw fa-github'></i> GitHub repo"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"ds"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">10</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-camera'></i> Showcases"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s2">"more/showcase/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">11</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentation"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"hugodoc"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s2">"https://gohugo.io/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">20</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-bullhorn'></i> Credits"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s2">"more/credits/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">30</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-tags'></i> Tags"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s2">"tags/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">40</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="p">=</span> <span class="s2">"Cap'n Hugo Relearrrn Theme"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">languageName</span> <span class="p">=</span> <span class="s2">"Arrr! Pirrrates"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">landingPageURL</span> <span class="p">=</span> <span class="s2">"/pir/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-home'></i> Arrr! Home"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fab fa-fw fa-github'></i> GitHub repo"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"ds"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">10</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-camera'></i> Showcases"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s2">"more/showcase/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">11</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentat'n"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">identifier</span> <span class="p">=</span> <span class="s2">"hugodoc"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s2">"https://gohugo.io/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">20</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-bullhorn'></i> Crrredits"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s2">"more/credits/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">30</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-fw fa-tags'></i> Arrr! Tags"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">url</span> <span class="p">=</span> <span class="s2">"tags/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">weight</span> <span class="p">=</span> <span class="mi">40</span>
|
||
</span></span></code></pre></div><p>Read more about <a href="https://gohugo.io/extras/menus/">hugo menu</a> an' <a href="https://gohugo.io/content-management/multilingual/#menus">hugo multilingual menus</a></p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Ay'cons an' logos</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' Relearrrn theme fer Cap'n Hugo loads th' <a href="https://fontawesome.com"><strong>Font Awesome</strong></a> library, allow'n ye t' easily display any ay'con or logo avail'ble 'n th' Font Awesome free collect'n.</p>
|
||
<h2 id="finding-an-icon">Find'n an ay'con</h2>
|
||
<p>Browse through th' avail'ble ay'cons 'n th' <a href="https://fontawesome.com/v5/search?m=free">Font Awesome Gallery</a>. Notice that th' <strong>free</strong> filter be enabled, as only th' free ay'cons be avail'ble by default.</p>
|
||
<p>Once on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' <a href="https://fontawesome.com/v5/icons/heart?s=solid">heart</a>, copy th' HTML reference an' paste into th' Marrrkdown rrrambl'n.</p>
|
||
<p>Th' HTML t' include th' heart ay'con be:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">i</span> <span class="na">class</span><span class="o">=</span><span class="s">"fas fa-heart"</span><span class="p">></</span><span class="nt">i</span><span class="p">></span>
|
||
</span></span></code></pre></div><h2 id="including-in-markdown">Includ'n 'n markdown</h2>
|
||
<p>Paste th' <code><i></code> HTML into marrrkup an' Font Awesome will board th' relevant ay'con.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl">Built wit' <span class="p"><</span><span class="nt">i</span> <span class="na">class</span><span class="o">=</span><span class="s">"fas fa-heart"</span><span class="p">></</span><span class="nt">i</span><span class="p">></span> by Relearrrn an' Cap'n Hugo
|
||
</span></span></code></pre></div><p>Which appears as</p>
|
||
<p>Built wit' <i class="fas fa-heart"></i> by Relearrrn an' Cap'n Hugo</p>
|
||
<h2 id="customising-icons">Customis'n ay'cons</h2>
|
||
<p>Font Awesome provides many ways t' modify th' ay'con</p>
|
||
<ul>
|
||
<li>Change color (by default th' ay'con will inherit th' parent color)</li>
|
||
<li>Increase or decrease size</li>
|
||
<li>Rotate</li>
|
||
<li>Combine wit' other ay'cons</li>
|
||
</ul>
|
||
<p>Check th' full documentat'n on <a href="https://fontawesome.com/how-to-use/web-fonts-with-css">web fonts wit' CSS</a> fer more.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Multilingual an' i18n</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.</p>
|
||
<p>It provides:</p>
|
||
<ul>
|
||
<li>Translat'n str'ns fer default values (English, Piratized English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese). Feel free t' contribute!</li>
|
||
<li>Automatic menu generat'n from multilingual rrrambl'n</li>
|
||
<li>In-browser language switch'n</li>
|
||
</ul>
|
||
<p><img src="/hugo-theme-relearn/cont/i18n/images/i18n-menu.gif?classes=shadow&width=300px" alt="I18n menu"></p>
|
||
<h2 id="basic-configuration">Basic configurat'n</h2>
|
||
<p>Aft learn'n <a href="https://gohugo.io/content-management/multilingual">how Cap'n Hugo handle multilingual websites</a>, define yer languages 'n yer <code>config.toml</code> file.</p>
|
||
<p>For example wit' current English an' Piratized English website.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="c"># English be th' default language</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">defaultContentLanguage</span> <span class="p">=</span> <span class="s2">"en"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">Languages</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">en</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Hugo Relearrrn Theme"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">languageName</span> <span class="p">=</span> <span class="s2">"English"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">Languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Cap'n Hugo Relearrrn Theme"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">2</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">languageName</span> <span class="p">=</span> <span class="s2">"Arrr! Pirrrates"</span>
|
||
</span></span></code></pre></div><p>Then, fer each new plank, append th' <em>id</em> o' th' language t' th' file.</p>
|
||
<ul>
|
||
<li>Single file <code>my-page.md</code> be split 'n two files:
|
||
<ul>
|
||
<li>'n English: <code>my-page.md</code></li>
|
||
<li>'n Piratized English: <code>my-page.pir.md</code></li>
|
||
</ul>
|
||
</li>
|
||
<li>Single file <code>_index.md</code> be split 'n two files:
|
||
<ul>
|
||
<li>'n English: <code>_index.md</code></li>
|
||
<li>'n Piratized English: <code>_index.pir.md</code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div class="box notices info">
|
||
<div class="box-label"><i class="fas fa-info-circle fa-fw"></i> Ahoi</div>
|
||
<div class="box-content">
|
||
<p>Be aware that only translated planks be displayed 'n menu. It’s not replaced wit' default language rrrambl'n.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices tip">
|
||
<div class="box-label"><i class="fas fa-lightbulb fa-fw"></i> Smarrrt Arrrse</div>
|
||
<div class="box-content">
|
||
<p>Use <a href="https://gohugo.io/content-management/multilingual/#translate-your-content">slug</a> Front Matter parameter t' translate urls too.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 id="overwrite-translation-strings">Overwrite translat'n str'ns</h2>
|
||
<p>Translat'ns str'ns be used fer common default values used 'n th' theme (<em>Edit</em> button, <em>Search placeholder</em> an' so on). Translat'ns be avail'ble 'n English an' Piratized English but ye may use another language or want t' override default values.</p>
|
||
<p>T' override these values, create a new file 'n yer local i18n folder <code>i18n/<idlanguage>.toml</code> an' inspire yourself from th' theme <code>themes/hugo-theme-relearn/i18n/en.toml</code></p>
|
||
<h2 id="disable-language-switching">Dis'ble language switch'n</h2>
|
||
<p>Switch'n th' language 'n th' browser be a great feature, but fer some reasons ye may want t' dis'ble it.</p>
|
||
<p>Just set <code>disableLanguageSwitchingButton=true</code> 'n yer <code>config.toml</code></p>
|
||
<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="c"># When us'n mulitlingual website, dis'ble th' switch language button.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableLanguageSwitchingButton</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span></code></pre></div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Tags</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' Relearrrn theme supports one default taxonomy o' Cap'n Hugo: th' <em>tag</em> feature.</p>
|
||
<h2 id="configuration">Configurat'n</h2>
|
||
<p>Just add tags t' any plank:</p>
|
||
<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">tags</span> <span class="p">=</span> <span class="p">[</span><span class="s2">"tutorial"</span><span class="p">,</span> <span class="s2">"theme"</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Theme tutorial"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">15</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span></code></pre></div><h2 id="behavior">Behavior</h2>
|
||
<p>Th' tags be displayed at th' top o' th' plank, 'n their insert'n order.</p>
|
||
<p>Each tag be a link t' a <em>Taxonomy</em> plank display'n all th' articles wit' th' given tag.</p>
|
||
<h2 id="list-all-the-tags">List all th' tags</h2>
|
||
<p>In th' <code>config.toml</code> file ye can add a shortcut t' display all th' tags</p>
|
||
<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">menu</span><span class="p">.</span><span class="nx">shortcuts</span><span class="p">]]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">name</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-tags'></i> Tags"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">url</span> <span class="p">=</span> <span class="s2">"/tags"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">weight</span> <span class="p">=</span> <span class="mi">30</span>
|
||
</span></span></code></pre></div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
</section>
|
||
|
||
<article class="chapter">
|
||
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<h3 id="chapter-3">Chapter 3</h3>
|
||
<h1 id="shortcodes">Shorrrtcodes</h1>
|
||
<p>Cap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well. Ye could use pure HTML t' expand possibilities.</p>
|
||
<p>But this happens t' be a bad idea. Everyone uses Marrrkdown because it’s pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.</p>
|
||
<p>T' avoid this limitat'ns, Cap'n Hugo created <a href="https://gohugo.io/extras/shortcodes/">shorrrtcodes</a>. A shorrrtcode be a simple snippet inside a plank.</p>
|
||
<p>Th' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.</p>
|
||
|
||
|
||
<div class="children children-h2 children-sort-">
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/attachments/" >Attachments</a></h2>
|
||
<p>Th' Attachments shorrrtcode displays a list o' files attached t' a plank</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/button/" >Button</a></h2>
|
||
<p>Nice buttons on yer plank</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/children/" >Children</a></h2>
|
||
<p>List th' child planks o' a plank</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/expand/" >Expand</a></h2>
|
||
<p>Displays an expandable/collaps'ble section o' text on yer plank</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/include/" >Include</a></h2>
|
||
<p>Displays rrrambl'n from other Marrrkdown files</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/mermaid/" >Merrrmaid</a></h2>
|
||
<p>Generat'n o' diagram an' flowchart from text 'n a similar manner as Marrrkdown</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/notice/" >Notice</a></h2>
|
||
<p>Disclaimers t' help ye structure yer plank</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/siteparam/" >Ship param</a></h2>
|
||
<p>Get value o' ship params variables 'n yer plank</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/swagger/" >Swagger</a></h2>
|
||
<p>Adds UI fer yer Swagger / OpenAPI Specificat'ns</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/tabs/" >Tabbed views</a></h2>
|
||
<p>Synchr'nize select'n o' rrrambl'n 'n different tabbed views</p>
|
||
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
<section>
|
||
|
||
<article>
|
||
|
||
<h1>Attachments</h1>
|
||
|
||
<div class="box attachments transparent">
|
||
<div class="box-label"><i class="fas fa-paperclip fa-fw"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.pir.files/NoTreasure.txt">NoTreasure.txt</a> (26 B)</li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' Attachments shorrrtcode displays a list o' files attached t' a plank.</p>
|
||
|
||
<div class="box attachments transparent">
|
||
<div class="box-label"><i class="fas fa-paperclip fa-fw"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/hugo.png">hugo.png</a> (17 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
|
||
<li><a href="/hugo-theme-relearn/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>Th' shortcurt lists files found 'n a <strong>specific folder</strong>.
|
||
Currently, it support two implementat'ns fer planks</p>
|
||
<ol>
|
||
<li>
|
||
<p>If yer plank be a Marrrkdown file, attachements must be placed 'n a <strong>folder</strong> named like yer plank an' end'n wit' <strong>.files</strong>.</p>
|
||
<blockquote>
|
||
<ul>
|
||
<li>rrrambl'n
|
||
<ul>
|
||
<li>_index.md</li>
|
||
<li>plank.files
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
<li>plank.md</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</blockquote>
|
||
</li>
|
||
<li>
|
||
<p>If yer plank be a <strong>folder</strong>, attachements must be placed 'n a nested <strong>‘files’</strong> folder.</p>
|
||
<blockquote>
|
||
<ul>
|
||
<li>rrrambl'n
|
||
<ul>
|
||
<li>_index.md</li>
|
||
<li>plank
|
||
<ul>
|
||
<li>index.md</li>
|
||
<li>files
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</blockquote>
|
||
</li>
|
||
</ol>
|
||
<p>Be aware that if ye use a multilingual website, ye will need t' have as many folders as languages.</p>
|
||
<p>That’s all!</p>
|
||
<h3 id="parameters">Parameters</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:left">Parameter</th>
|
||
<th style="text-align:left">Default</th>
|
||
<th style="text-align:left">Descript'n</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:left">title</td>
|
||
<td style="text-align:left">“Attachments”</td>
|
||
<td style="text-align:left">List’s title</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">ay'con</td>
|
||
<td style="text-align:left">“paperclip”</td>
|
||
<td style="text-align:left">Sets th' ay'con near th' title; if ye want no ay'con at all, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">sort</td>
|
||
<td style="text-align:left">“asc”</td>
|
||
<td style="text-align:left">Sort'n th' output 'n <code>asc</code>end'n or <code>desc</code>end'n order</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">style</td>
|
||
<td style="text-align:left">""</td>
|
||
<td style="text-align:left">Choose between <code>orange</code>, <code>grey</code>, <code>blue</code> an' <code>green</code> fer nice style</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">pattern</td>
|
||
<td style="text-align:left">“.*”</td>
|
||
<td style="text-align:left">A regular expressions, used t' filter th' attachments by file name. <br/><br/>Th' <strong>pattern</strong> parameter value must be <a href="https://en.wikipedia.org/wiki/Regular_expression">regular expressions</a>.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>For example:</p>
|
||
<ul>
|
||
<li>T' match a file suffix o' ‘jpg’, use *<em>.<em>jpg</em></em> (not *.jpg).</li>
|
||
<li>T' match file names end'n 'n ‘jpg’ or ‘png’, use <strong>.*(jpg|png)</strong></li>
|
||
</ul>
|
||
<h3 id="examples">Examples</h3>
|
||
<h4 id="list-of-attachments-ending-in-pdf-or-mp4">List o' attachments end'n 'n pdf or mp4</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">attachments</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Related files"</span> <span class="nx">pattern</span><span class="p">=</span><span class="s">".*(pdf|mp4)"</span><span class="o">/%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div><p>renders as</p>
|
||
|
||
<div class="box attachments transparent">
|
||
<div class="box-label"><i class="fas fa-paperclip fa-fw"></i> Related files</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<h4 id="colored-styled-box">Colored styled box</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">attachments</span> <span class="nx">style</span><span class="p">=</span><span class="s">"orange"</span> <span class="o">/%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div><p>renders as</p>
|
||
|
||
<div class="box attachments orange">
|
||
<div class="box-label"><i class="fas fa-paperclip fa-fw"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/hugo.png">hugo.png</a> (17 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<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">"grey"</span> <span class="o">/%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div><p>renders as</p>
|
||
|
||
<div class="box attachments grey">
|
||
<div class="box-label"><i class="fas fa-paperclip fa-fw"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/hugo.png">hugo.png</a> (17 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<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">"blue"</span> <span class="o">/%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div><p>renders as</p>
|
||
|
||
<div class="box attachments blue">
|
||
<div class="box-label"><i class="fas fa-paperclip fa-fw"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/hugo.png">hugo.png</a> (17 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<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">"green"</span> <span class="o">/%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div><p>renders as</p>
|
||
|
||
<div class="box attachments green">
|
||
<div class="box-label"><i class="fas fa-paperclip fa-fw"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/hugo.png">hugo.png</a> (17 KB)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
|
||
<li><a href="/hugo-theme-relearn/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Button</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>A button be a just a click'ble button wit' optional ay'con.</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">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"https://gohugo.io/"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Cap'n 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">"https://gohugo.io/"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"fas fa-download"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Cap'n Hugo</span> <span class="nx">wit'</span> <span class="nx">ay'con</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">"https://gohugo.io/"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"fas fa-download"</span> <span class="nx">ay'con</span><span class="o">-</span><span class="nx">posit'n</span><span class="p">=</span><span class="s">"right"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Cap'n Hugo</span> <span class="nx">wit'</span> <span class="nx">ay'con</span> <span class="nx">right</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>
|
||
<a href="https://gohugo.io/" target="_blank" class="btn btn-default">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
|
||
|
||
<a href="https://gohugo.io/" target="_blank" class="btn btn-default">
|
||
<i class="fas fa-download"></i>
|
||
Get Cap'n Hugo wit' ay'con
|
||
</a>
|
||
|
||
|
||
<a href="https://gohugo.io/" target="_blank" class="btn btn-default">
|
||
Get Cap'n Hugo wit' ay'con right
|
||
<i class="fas fa-download"></i>
|
||
</a>
|
||
</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Children</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Use th' children shorrrtcode t' list th' child planks o' a plank an' th' further descendants (children’s children). By default, th' shorrrtcode displays links t' th' child planks.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:left">Parameter</th>
|
||
<th style="text-align:left">Default</th>
|
||
<th style="text-align:left">Descript'n</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:left">plank</td>
|
||
<td style="text-align:left"><em>current</em></td>
|
||
<td style="text-align:left">Specify th' plank name (section name) t' display children fer</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">containerstyle</td>
|
||
<td style="text-align:left">“ul”</td>
|
||
<td style="text-align:left">Choose th' style used t' group all children. It could be any HTML tag name</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">style</td>
|
||
<td style="text-align:left">“li”</td>
|
||
<td style="text-align:left">Choose th' style used t' display each descendant. It could be any HTML tag name</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">showhidden</td>
|
||
<td style="text-align:left">“false”</td>
|
||
<td style="text-align:left">When true, child planks hidden from th' menu will be displayed</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">descript'n</td>
|
||
<td style="text-align:left">“false”</td>
|
||
<td style="text-align:left">Allows ye t' include a short text under each plank 'n th' list. When no descript'n exists fer th' plank, children shorrrtcode takes th' first 70 words o' yer rrrambl'n. <a href="https://gohugo.io/content/summaries/">Read more info about summaries on gohugo.io</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">depth</td>
|
||
<td style="text-align:left">1</td>
|
||
<td style="text-align:left">Enter a number t' specify th' depth o' descendants t' display. For example, if th' value be 2, th' shorrrtcode will display 2 levels o' child planks. <strong>Tips:</strong> set 999 t' get all descendants</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">sort</td>
|
||
<td style="text-align:left"><a href="/hugo-theme-relearn/pir/basics/configuration/#global-site-parameters">ordersectionsby</a></td>
|
||
<td style="text-align:left">Sort children by <strong>weight</strong>, t' sort on menu order - <strong>title</strong>, t' sort alphabetically on menu label. If not set it be sorted by th' <code>ordersectionsby</code> sett'n o' th' ship an' th' planks frontmatter</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="demo">Demo</h2>
|
||
<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="/hugo-theme-relearn/pir/shortcodes/children/test/" >plank X</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/" >plank 1</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-2/" >plank 2</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/" >plank 3</a></li>
|
||
</ul>
|
||
<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">descript'n</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div>
|
||
|
||
<ul class="children children-li children-sort-">
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/test/" >plank X</a></li>
|
||
<p>This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n...
|
||
</p>
|
||
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/" >plank 1</a></li>
|
||
<p>This be a demo child plank</p>
|
||
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-2/" >plank 2</a></li>
|
||
<p>This be a demo child plank wit' no descript'n.
|
||
So its rrrambl'n be used as descript'n.</p>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/" >plank 3</a></li>
|
||
<p>This be a demo child plank</p>
|
||
|
||
</ul>
|
||
<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">"999"</span> <span class="nx">showhidden</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div>
|
||
|
||
<ul class="children children-li children-sort-">
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/test/" >plank X</a></li><ul></ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/" >plank 1</a></li><ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/" >plank 1-1</a></li><ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/" >plank 1-1-1 (hidden)</a></li><ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/" >plank 1-1-1-1</a></li><ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/" >plank 1-1-1-1-1 (hidden)</a></li><ul>
|
||
<li><a href="/hugo-theme-relearn/pir/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/" >plank 1-1-1-1-1-1</a></li><ul></ul></ul></ul></ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/" >plank 1-1-2</a></li><ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/" >plank 1-1-2-1</a></li><ul></ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/" >plank 1-1-2-2</a></li><ul></ul></ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/" >plank 1-1-3</a></li><ul></ul></ul></ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-2/" >plank 2</a></li><ul></ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/" >plank 3</a></li><ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/" >plank 3-1</a></li><ul></ul></ul>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-4/" >plank 4 (hidden)</a></li><ul></ul>
|
||
</ul>
|
||
<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">"div"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"h2"</span> <span class="nx">depth</span><span class="p">=</span><span class="s">"3"</span> <span class="nx">descript'n</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div>
|
||
|
||
<div class="children children-h2 children-sort-">
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/children/test/" >plank X</a></h2>
|
||
<p>This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n...
|
||
</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/" >plank 1</a></h2>
|
||
<p>This be a demo child plank</p>
|
||
|
||
|
||
<h3><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/" >plank 1-1</a></h3>
|
||
<p>This be a demo child plank</p>
|
||
|
||
|
||
<h4><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/" >plank 1-1-2</a></h4>
|
||
<p>This be a demo child plank</p>
|
||
|
||
|
||
<h4><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/" >plank 1-1-3</a></h4>
|
||
<p>This be a demo child plank</p>
|
||
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/children/children-2/" >plank 2</a></h2>
|
||
<p>This be a demo child plank wit' no descript'n.
|
||
So its rrrambl'n be used as descript'n.</p>
|
||
|
||
<h2><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/" >plank 3</a></h2>
|
||
<p>This be a demo child plank</p>
|
||
|
||
|
||
<h3><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/" >plank 3-1</a></h3>
|
||
<p>This be a plain plank test nested 'n a parent</p>
|
||
|
||
</div>
|
||
<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">"div"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"div"</span> <span class="nx">depth</span><span class="p">=</span><span class="s">"999"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div>
|
||
|
||
<div class="children children-div children-sort-">
|
||
<div><a href="/hugo-theme-relearn/pir/shortcodes/children/test/" >plank X</a></div>
|
||
<div><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/" >plank 1</a></div>
|
||
<div><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/" >plank 1-1</a></div>
|
||
<div><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/" >plank 1-1-2</a></div>
|
||
<div><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/" >plank 1-1-2-1</a></div>
|
||
<div><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/" >plank 1-1-2-2</a></div>
|
||
<div><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/" >plank 1-1-3</a></div>
|
||
<div><a href="/hugo-theme-relearn/pir/shortcodes/children/children-2/" >plank 2</a></div>
|
||
<div><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/" >plank 3</a></div>
|
||
<div><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/" >plank 3-1</a></div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
<section>
|
||
|
||
<article>
|
||
|
||
<h1>Plank X</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Plank 1</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This be a demo child plank.</p>
|
||
<h2 id="subpages-of-this-page">Subpages o' this plank</h2>
|
||
|
||
|
||
<ul class="children children-li children-sort-">
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/" >plank 1-1</a></li>
|
||
</ul>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
<section>
|
||
|
||
<article>
|
||
|
||
<h1>Plank 1-1</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This be a demo child plank wit' a hidden child. Ye can still access th' hidden child <a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/">directly</a> or via th' search.</p>
|
||
<h2 id="subpages-of-this-page">Subpages o' this plank</h2>
|
||
|
||
|
||
<ul class="children children-li children-sort-">
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/" >plank 1-1-1 (hidden)</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/" >plank 1-1-2</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/" >plank 1-1-3</a></li>
|
||
</ul>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
<section>
|
||
|
||
<article>
|
||
|
||
<h1>Plank 1-1-2</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
<h2 id="subpages-of-this-page">Subpages o' this plank</h2>
|
||
|
||
|
||
<ul class="children children-li children-sort-">
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/" >plank 1-1-2-1</a></li>
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/" >plank 1-1-2-2</a></li>
|
||
</ul>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
<section>
|
||
|
||
<article>
|
||
|
||
<h1>Plank 1-1-2-1</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Plank 1-1-2-2</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
</section>
|
||
|
||
<article>
|
||
|
||
<h1>Plank 1-1-3</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
</section>
|
||
</section>
|
||
|
||
<article>
|
||
|
||
<h1>Plank 2</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This be a demo child plank wit' no descript'n.</p>
|
||
<p>So its rrrambl'n be used as descript'n.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Plank 3</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This be a demo child plank.</p>
|
||
<h2 id="subpages-of-this-page">Subpages o' this plank</h2>
|
||
|
||
|
||
<ul class="children children-li children-sort-">
|
||
<li><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/" >plank 3-1</a></li>
|
||
</ul>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
<section>
|
||
|
||
<article>
|
||
|
||
<h1>Plank 3-1</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
</section>
|
||
</section>
|
||
|
||
<article>
|
||
|
||
<h1>Expand</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' Expand shorrrtcode displays an expandable/collaps'ble section o' text on yer plank.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<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="p">[</span> <span class="p"><</span><span class="kt">str'n</span><span class="p">></span> <span class="p">[</span> <span class="s">"true"</span> <span class="p">|</span> <span class="s">"false"</span> <span class="p">]</span> <span class="p">]</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Yes</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><p>Th' first optional parameter defines th' text that appears next t' th' expand/collapse ay'con. Th' default text be <code>"Expand me..."</code>.</p>
|
||
<p>Th' second optional parameter controls if th' block be initially shown as expanded (<code>"true"</code>) or collapsed (<code>"false"</code>). Th' default ist <code>"false"</code>.</p>
|
||
<h2 id="examples">Examples</h2>
|
||
|
||
<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-right"></i>
|
||
I'll tell ye a secret...
|
||
</a>
|
||
<div class="expand-content" style="display: none;">
|
||
<p>…maybe th' next time you’ll open this expander!</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h3 id="all-defaults">All defaults</h3>
|
||
|
||
<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-right"></i>
|
||
Expand me...
|
||
</a>
|
||
<div class="expand-content" style="display: none;">
|
||
<p>Yes, ye did it!</p>
|
||
|
||
</div>
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: block;">
|
||
<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></span><span class="line"><span class="cl"><span class="nx">Yes</span><span class="p">,</span> <span class="nx">ye</span> <span class="nx">did</span> <span class="nx">it</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>
|
||
</div>
|
||
<h3 id="initially-expanded">Initially expanded</h3>
|
||
|
||
<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-right"></i>
|
||
Expand me...
|
||
</a>
|
||
<div class="expand-content" style="display: block;">
|
||
<p>No need t' press ye!</p>
|
||
|
||
</div>
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: block;">
|
||
<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">"Expand me..."</span> <span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">No</span> <span class="nx">need</span> <span class="nx">t'</span> <span class="nx">press</span> <span class="nx">ye</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>
|
||
</div>
|
||
<h3 id="arbitrary-text">Arbitrary text</h3>
|
||
|
||
<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-right"></i>
|
||
Show me endless possibilities
|
||
</a>
|
||
<div class="expand-content" style="display: none;">
|
||
<p>Some expand'ble text.</p>
|
||
<p>Ye can add:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> an' even <strong><em>bold emphasized</em></strong> text</li>
|
||
<li><a href="https://example.com">links</a></li>
|
||
<li>other shorrrtcodes besides <code>expand</code></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>th' possiblities be endless</p>
|
||
</blockquote>
|
||
|
||
</div>
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: none;">
|
||
<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">"Show me endless possibilities"</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">expand'ble</span> <span class="nx">text</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Ye</span> <span class="nx">can</span> <span class="nx">add</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">an'</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">other</span> <span class="nx">shorrrtcodes</span> <span class="nx">besides</span> <span class="s">`expand`</span>
|
||
</span></span><span class="line"><span class="cl"><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">></span> <span class="nx">th'</span> <span class="nx">possiblities</span> <span class="nx">be</span> <span class="nx">endless</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>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Include</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' include shorrrtcode includes other files from yer project inside o' th' current file. This can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<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="p"><</span><span class="kt">str'n</span><span class="p">></span> <span class="p">[</span> <span class="s">"true"</span> <span class="p">|</span> <span class="s">"false"</span> <span class="p">]</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div><p>Th' first required parameter be th' path t' th' file t' be included.</p>
|
||
<p>If th' file’s rrrambl'n will be displayed as HTML, th' second optional parameter controls if th' first head'n o' th' included file should be displayed (<code>"true"</code>)- which be th' default - or be hidden.</p>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="arbitray-content">Arbitray rrrambl'n</h3>
|
||
<p>Ye can add:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> an' even <strong><em>bold emphasized</em></strong> text</li>
|
||
<li><a href="https://example.com">links</a></li>
|
||
<li>other shorrrtcodes besides <code>include</code></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>th' possiblities be endless</p>
|
||
</blockquote>
|
||
|
||
<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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: none;">
|
||
<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">"shortcodes/INCLUDE_ME.md"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Merrrmaid</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p><a href="https://mermaidjs.github.io/">Merrrmaid</a> be a library help'n ye t' generate diagram an' flowcharts from text, 'n a similar manner as Marrrkdown.</p>
|
||
|
||
<div class="box notices note">
|
||
<div class="box-label"><i class="fas fa-exclamation-circle fa-fw"></i> Avast</div>
|
||
<div class="box-content">
|
||
<p>This only works 'n modern browsers.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label"><i class="fas fa-exclamation-triangle fa-fw"></i> Arrr</div>
|
||
<div class="box-content">
|
||
<p>Due t' limitat'ns wit' <a href="https://github.com/mermaid-js/mermaid/issues/1846">Merrrmaid</a>, it be currently not poss'ble t' use Merrrmaid code fences 'n an initially collapsed <code>expand</code> shorrrtcode. This be a know issue an' <a href="https://github.com/McShelby/hugo-theme-relearn/issues/187">can’t be fixed by this theme</a>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>Just insert yer Merrrmaid code 'n th' <code>mermaid</code> shorrrtcode like this:</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">{{<</span> <span class="nx">mermaid</span> <span class="p">[</span> <span class="nx">align</span><span class="p">=(</span><span class="s">"left"</span><span class="p">|</span><span class="s">"right"</span><span class="p">|</span><span class="s">"center"</span><span class="p">|</span><span class="s">"justify"</span><span class="p">)</span> <span class="p">]</span> <span class="p">>}}</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">Person</span> <span class="o">*--</span> <span class="nx">Dog</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div><p>Ye can set an optional <code>align</code> attribute which defaults t' <code>"center"</code>.</p>
|
||
<p>If ye don’t need alignment ye can use th' alternative rules us'n code fences if ye have turned off <code>guessSyntax</code> fer th' <code>marrrkup.highlight</code> sett'n (see below):</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">```mermaid
|
||
</span></span><span class="line"><span class="cl">classDiagram
|
||
</span></span><span class="line"><span class="cl"> Person *-- Dog
|
||
</span></span><span class="line"><span class="cl">```
|
||
</span></span></code></pre></div><p>Th' generated graphs can be be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.</p>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="flowchart">Flowchart</h3>
|
||
|
||
<div class="mermaid" align="left">
|
||
%%{init:{"theme":"forest"}}%%
|
||
graph LR;
|
||
A[Hard edge] -->|Link text| B(Round edge)
|
||
B --> C{<strong>Decision</strong>}
|
||
C -->|One| D[Result one]
|
||
C -->|Two| E[Result two]
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: block;">
|
||
<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">mermaid</span> <span class="nx">align</span><span class="p">=</span><span class="s">"left"</span> <span class="p">>}}</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">"theme"</span><span class="p">:</span><span class="s">"forest"</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">>|</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">></span> <span class="nx">C</span><span class="p">{<</span><span class="nx">strong</span><span class="p">></span><span class="nx">Decision</span><span class="p"><</span><span class="o">/</span><span class="nx">strong</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">>|</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">>|</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">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<h3 id="sequence">Sequence</h3>
|
||
|
||
<div class="mermaid" align="center">
|
||
sequenceDiagram
|
||
participant Alice
|
||
participant Bob
|
||
Alice->>John: Hello John, how be ye?
|
||
loop Healthcheck
|
||
John->John: Fight against hypochondria
|
||
end
|
||
Note right of John: Rational thoughts <br/>prevail...
|
||
John-->Alice: Great!
|
||
John->Bob: How about ye?
|
||
Bob-->John: Jolly bloody!
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: block;">
|
||
<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">mermaid</span> <span class="p">>}}</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">->></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">be</span> <span class="nx">ye</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">></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">Avast</span> <span class="nx">right</span> <span class="nx">o'</span> <span class="nx">John</span><span class="p">:</span> <span class="nx">Rational</span> <span class="nx">thoughts</span> <span class="p"><</span><span class="nx">br</span><span class="o">/</span><span class="p">></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">></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">></span><span class="nx">Bob</span><span class="p">:</span> <span class="nx">How</span> <span class="nx">about</span> <span class="nx">ye</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">></span><span class="nx">John</span><span class="p">:</span> <span class="nx">Jolly</span> <span class="nx">bloody</span><span class="p">!</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<h3 id="gantt">GANTT</h3>
|
||
|
||
<div class="mermaid" align="center">
|
||
gantt
|
||
dateFormat YYYY-MM-DD
|
||
title Add'n GANTT diagram functionality t' Merrrmaid
|
||
section A section
|
||
Completed task :done, des1, 2014-01-06,2014-01-08
|
||
Active task :active, des2, 2014-01-09, 3d
|
||
Future task : des3, aft des2, 5d
|
||
Future task2 : des4, aft des3, 5d
|
||
section Critical tasks
|
||
Completed task 'n th' critical line :crit, done, 2014-01-06,24h
|
||
Implement parser an' jison :crit, done, aft des1, 2d
|
||
Create tests fer parser :crit, active, 3d
|
||
Future task 'n critical line :crit, 5d
|
||
Create tests fer renderer :2d
|
||
Add t' Merrrmaid :1d
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: block;">
|
||
<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">mermaid</span> <span class="p">>}}</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">Add'n</span> <span class="nx">GANTT</span> <span class="nx">diagram</span> <span class="nx">functionality</span> <span class="nx">t'</span> <span class="nx">Merrrmaid</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">aft</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">aft</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">'n</span> <span class="nx">th'</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">an'</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">aft</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">fer</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">'n</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">fer</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">t'</span> <span class="nx">Merrrmaid</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">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<h3 id="class">Class</h3>
|
||
|
||
<div class="mermaid" align="center">
|
||
classDiagram
|
||
Class01 <|-- AveryLongClass : Cool
|
||
Class03 *-- Class04
|
||
Class05 o-- Class06
|
||
Class07 .. Class08
|
||
Class09 --> C2 : Whar' am i?
|
||
Class09 --* C3
|
||
Class09 --|> Class07
|
||
Class07 : equals()
|
||
Class07 : Object[] elementData
|
||
Class01 : size()
|
||
Class01 : int chimp
|
||
Class01 : int gorilla
|
||
Class08 <--> C2: Cool label
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: block;">
|
||
<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">mermaid</span> <span class="p">>}}</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"><|</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">></span> <span class="nx">C2</span> <span class="p">:</span> <span class="nx">Whar'</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">|></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"><--</span><span class="p">></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">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<h3 id="state">State</h3>
|
||
<div class="mermaid" align="center">stateDiagram-v2
|
||
open: Open Door
|
||
closed: Closed Door
|
||
locked: Locked Door
|
||
open --> closed: Close
|
||
closed --> locked: Lock
|
||
locked --> closed: Unlock
|
||
closed --> open: Open</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: block;">
|
||
<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 --> closed: Close
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> closed --> locked: Lock
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> locked --> closed: Unlock
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> closed --> open: Open
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<h2 id="configuration">Configurat'n</h2>
|
||
<p>Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaid’s default sett'ns fer all o' yer files thru a JSON object 'n yer <code>config.toml</code>, override these sett'ns per plank thru yer planks frontmatter or override these sett'n per diagramm thru <a href="https://mermaid-js.github.io/mermaid/#/directives?id=directives">diagram directives</a>.</p>
|
||
<p>Th' JSON object o' yer <code>config.toml</code> / frontmatter be forwarded into Mermaid’s <code>mermaid.initialize()</code> funct'n.</p>
|
||
<p>See <a href="http://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults">Merrrmaid documentat'n</a> fer all allowed sett'ns.</p>
|
||
<p>Th' <code>theme</code> sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n <code>config.toml</code>, frontmatter or diagram directives.</p>
|
||
|
||
<div class="box notices note">
|
||
<div class="box-label"><i class="fas fa-exclamation-circle fa-fw"></i> Avast</div>
|
||
<div class="box-content">
|
||
<p>If ye want t' use mermaid codefences, ye have t' turn off <code>guessSyntax</code> fer th' <code>marrrkup.highlight</code> sett'n.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h3 id="example">Example</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">"{ \"theme\": \"dark\" }"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">marrrkup</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">marrrkup</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 set t' `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 code fences will not work anymore! So this be a mandatory</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># sett'n fer yer ship</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><p>or planks frontmatter</p>
|
||
<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">"{ \"theme\": \"dark\" }"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span></code></pre></div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Notice</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' notice shorrrtcode shows four types o' disclaimers t' help ye structure yer plank.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<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="nf">notice</span> <span class="p">(</span> <span class="nx">note</span> <span class="p">|</span> <span class="nx">info</span> <span class="p">|</span> <span class="nx">tip</span> <span class="p">|</span> <span class="nx">warning</span> <span class="p">)</span> <span class="p">[</span> <span class="p"><</span><span class="kt">str'n</span><span class="p">></span> <span class="p">[</span> <span class="p"><</span><span class="kt">str'n</span><span class="p">></span> <span class="p">]</span> <span class="p">]</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">marrrkup</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><p>Th' first parameter be required an' indicates th' type o' notice.</p>
|
||
<p>Th' second parameter be optional. If provided, it will be used as th' title o' th' notice. If not provided, then th' type o' notice will be used as th' title. For example, th' title o' a warning notice will be “Warning”.</p>
|
||
<p>Th' third parameter be optional. If provided, it will set th' ay'con o' near th' title. For th' standard types o' notices, this be automatically determined but can be overridden wit' this parameter. If ye want no ay'con at all, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces).</p>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="note">Avast</h3>
|
||
|
||
<div class="box notices note">
|
||
<div class="box-label"><i class="fas fa-exclamation-circle fa-fw"></i> Avast</div>
|
||
<div class="box-content">
|
||
<p>A <strong>notice</strong> disclaimer</p>
|
||
<p>Ye can add:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> an' even <em><strong>bold emphasized</strong></em> text</li>
|
||
<li><a href="https://example.com">links</a></li>
|
||
<li>other shorrrtcodes besides <code>notice</code></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>th' possiblities be endless</p>
|
||
</blockquote>
|
||
|
||
</div>
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: none;">
|
||
<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">note</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></span><span class="line"><span class="cl"><span class="nx">Ye</span> <span class="nx">can</span> <span class="nx">add</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">an'</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">other</span> <span class="nx">shorrrtcodes</span> <span class="nx">besides</span> <span class="s">`notice`</span>
|
||
</span></span><span class="line"><span class="cl"><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">></span> <span class="nx">th'</span> <span class="nx">possiblities</span> <span class="nx">be</span> <span class="nx">endless</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>
|
||
<h3 id="info">Ahoi</h3>
|
||
|
||
<div class="box notices info">
|
||
<div class="box-label"><i class="fas fa-info-circle fa-fw"></i> Ahoi</div>
|
||
<div class="box-content">
|
||
<p>An <strong>informat'n</strong> disclaimer</p>
|
||
<p>Ye can add:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> an' even <em><strong>bold emphasized</strong></em> text</li>
|
||
<li><a href="https://example.com">links</a></li>
|
||
<li>other shorrrtcodes besides <code>notice</code></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>th' possiblities be endless</p>
|
||
</blockquote>
|
||
|
||
</div>
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: none;">
|
||
<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">info</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">informat'n</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">Ye</span> <span class="nx">can</span> <span class="nx">add</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">an'</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">other</span> <span class="nx">shorrrtcodes</span> <span class="nx">besides</span> <span class="s">`notice`</span>
|
||
</span></span><span class="line"><span class="cl"><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">></span> <span class="nx">th'</span> <span class="nx">possiblities</span> <span class="nx">be</span> <span class="nx">endless</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>
|
||
<h3 id="tip">Smarrrt Arrrse</h3>
|
||
|
||
<div class="box notices tip">
|
||
<div class="box-label"><i class="fas fa-lightbulb fa-fw"></i> Smarrrt Arrrse</div>
|
||
<div class="box-content">
|
||
<p>A <strong>tip</strong> disclaimer</p>
|
||
<p>Ye can add:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> an' even <em><strong>bold emphasized</strong></em> text</li>
|
||
<li><a href="https://example.com">links</a></li>
|
||
<li>other shorrrtcodes besides <code>notice</code></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>th' possiblities be endless</p>
|
||
</blockquote>
|
||
|
||
</div>
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: none;">
|
||
<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">tip</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><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Ye</span> <span class="nx">can</span> <span class="nx">add</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">an'</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">other</span> <span class="nx">shorrrtcodes</span> <span class="nx">besides</span> <span class="s">`notice`</span>
|
||
</span></span><span class="line"><span class="cl"><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">></span> <span class="nx">th'</span> <span class="nx">possiblities</span> <span class="nx">be</span> <span class="nx">endless</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>
|
||
<h3 id="warning">Arrr</h3>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label"><i class="fas fa-exclamation-triangle fa-fw"></i> Arrr</div>
|
||
<div class="box-content">
|
||
<p>A <strong>warning</strong> disclaimer</p>
|
||
<p>Ye can add:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> an' even <em><strong>bold emphasized</strong></em> text</li>
|
||
<li><a href="https://example.com">links</a></li>
|
||
<li>other shorrrtcodes besides <code>notice</code></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>th' possiblities be endless</p>
|
||
</blockquote>
|
||
|
||
</div>
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: none;">
|
||
<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">warning</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></span><span class="line"><span class="cl"><span class="nx">Ye</span> <span class="nx">can</span> <span class="nx">add</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">an'</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">other</span> <span class="nx">shorrrtcodes</span> <span class="nx">besides</span> <span class="s">`notice`</span>
|
||
</span></span><span class="line"><span class="cl"><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">></span> <span class="nx">th'</span> <span class="nx">possiblities</span> <span class="nx">be</span> <span class="nx">endless</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>
|
||
<h3 id="notice-with-default-color-custom-title-and-icon">Notice wit' default color, custom title an' ay'con</h3>
|
||
<p>Ye can cust'mize th' title o' th' notice by pass'n it as a second parameter.</p>
|
||
|
||
<div class="box notices default">
|
||
<div class="box-label"><i class="fas fa-skull-crossbones fa-fw"></i> Pay Attent'n t' this Avast!</div>
|
||
<div class="box-content">
|
||
<p>Th' title be now th' parameter that was provided.</p>
|
||
|
||
</div>
|
||
</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-right"></i>
|
||
Show marrrkup
|
||
</a>
|
||
<div class="expand-content" style="display: none;">
|
||
<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="k">default</span> <span class="s">"Pay Attent'n t' this Avast!"</span> <span class="s">"skull-crossbones"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Th'</span> <span class="nx">title</span> <span class="nx">be</span> <span class="nx">now</span> <span class="nx">th'</span> <span class="nx">parameter</span> <span class="nx">that</span> <span class="nx">was</span> <span class="nx">provided</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>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Ship param</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Th' <code>siteparam</code> shorrrtcode be used t' help ye print values o' ship params.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<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="p"><</span><span class="kt">str'n</span><span class="p">></span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div><p>Th' first required parameter be th' name o' th' ship param t' be displayed.</p>
|
||
<h2 id="examples">Examples</h2>
|
||
<p>For instance, 'n this current ship, th' <code>editURL</code> vari'ble be used 'n <code>config.toml</code></p>
|
||
<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">editURL</span> <span class="p">=</span> <span class="s2">"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/"</span>
|
||
</span></span></code></pre></div><p>Use th' <code>siteparam</code> shorrrtcode t' display its value.</p>
|
||
<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="s">"editURL"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div><p>be displayed as</p>
|
||
<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>
|
||
|
||
<h1>Swaggerrr</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This shorrrtcode uses th' <a href="https://mrin9.github.io/RapiDoc">RapiDoc</a> library t' display yer OpenAPI Specificat'ns.</p>
|
||
|
||
<div class="box notices note">
|
||
<div class="box-label"><i class="fas fa-exclamation-circle fa-fw"></i> Avast</div>
|
||
<div class="box-content">
|
||
<p>This only works 'n modern browsers.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<h2 id="configuration">Configurat'n</h2>
|
||
<p>Swagger be configured wit' default sett'ns. Ye can cust'mize Swagger’s default sett'ns fer all o' yer files thru a JSON object 'n yer <code>config.toml</code> or override these sett'ns per plank thru yer planks frontmatter.</p>
|
||
<p>Th' JSON object o' yer <code>config.toml</code> / frontmatter be forwarded into Swagger’s initializat'n. At th' moment, only th' <code>theme</code> sett'n be supported.</p>
|
||
<p>Th' <code>theme</code> sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n <code>config.toml</code> or frontmatter.</p>
|
||
<h3 id="example">Example</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">"{ \"theme\": \"dark\" }"</span>
|
||
</span></span></code></pre></div><h2 id="usage">Usage</h2>
|
||
<p>Just insert give th' URL t' yer OpenAPI Specificat'n like this:</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">{{<</span> <span class="nx">swagger</span> <span class="nx">src</span><span class="p">=</span><span class="s">"https://petstore3.swagger.io/api/v3/openapi.json"</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div><p>If yer plank be a leaf or branch bundle, ye can also use relative URLs:</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">{{<</span> <span class="nx">swagger</span> <span class="nx">src</span><span class="p">=</span><span class="s">"petstore.json"</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div><p>Th' <code>src</code> parameter be mandatory an' can be either an absolute or a relative URL.</p>
|
||
<h2 id="example-1">Example</h2>
|
||
|
||
<rapi-doc
|
||
allow-spec-file-download="true"
|
||
default-schema-tab="example"
|
||
font-size="largest"
|
||
layout="column"
|
||
load-fonts="false"
|
||
render-style="view"
|
||
schema-description-expanded="true"
|
||
schema-style="table"
|
||
show-header="false"
|
||
spec-url="/hugo-theme-relearn/pir/shortcodes/swagger/petstore.json"
|
||
sort-tags="true"
|
||
></rapi-doc>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article>
|
||
|
||
<h1>Tabbed views</h1>
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label">Arrr! ☠ Pirrrates ☠</div>
|
||
<div class="box-content">
|
||
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Choose which rrrambl'n t' see across th' plank. Very handy fer provid'n code
|
||
snippets fer multiple languages or provid'n configurat'n 'n different formats.</p>
|
||
<h2 id="code-example">Code example</h2>
|
||
<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">tabs</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">"python"</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("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">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">name</span><span class="p">=</span><span class="s">"R"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```R
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">> print("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">{{</span><span class="o">%</span> <span class="nx">tab</span> <span class="nx">name</span><span class="p">=</span><span class="s">"Bash"</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 "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">{{<</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div><p>Renders as:</p>
|
||
|
||
<div class="tab-panel">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="python"
|
||
data-tab-group="default"
|
||
class="tab-nav-button btn active"
|
||
onclick="switchTab('default','python')"
|
||
><span>python</span></button>
|
||
<button
|
||
data-tab-item="R"
|
||
data-tab-group="default"
|
||
class="tab-nav-button btn "
|
||
onclick="switchTab('default','R')"
|
||
><span>R</span></button>
|
||
<button
|
||
data-tab-item="Bash"
|
||
data-tab-group="default"
|
||
class="tab-nav-button btn "
|
||
onclick="switchTab('default','Bash')"
|
||
><span>Bash</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div data-tab-item="python" data-tab-group="default" 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">"Hello World!"</span><span class="p">)</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div data-tab-item="R" data-tab-group="default" class="tab-item ">
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-R" data-lang="R"><span class="line"><span class="cl"><span class="o">></span> <span class="nf">print</span><span class="p">(</span><span class="s">"Hello World!"</span><span class="p">)</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div data-tab-item="Bash" data-tab-group="default" 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">"Hello World!"</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Tab views wit' th' same tabs that belong t' th' same group sychr'nize their select'n:</p>
|
||
|
||
<div class="tab-panel">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="python"
|
||
data-tab-group="default"
|
||
class="tab-nav-button btn active"
|
||
onclick="switchTab('default','python')"
|
||
><span>python</span></button>
|
||
<button
|
||
data-tab-item="R"
|
||
data-tab-group="default"
|
||
class="tab-nav-button btn "
|
||
onclick="switchTab('default','R')"
|
||
><span>R</span></button>
|
||
<button
|
||
data-tab-item="Bash"
|
||
data-tab-group="default"
|
||
class="tab-nav-button btn "
|
||
onclick="switchTab('default','Bash')"
|
||
><span>Bash</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div data-tab-item="python" data-tab-group="default" 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">"Hello World!"</span><span class="p">)</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div data-tab-item="R" data-tab-group="default" class="tab-item ">
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-R" data-lang="R"><span class="line"><span class="cl"><span class="o">></span> <span class="nf">print</span><span class="p">(</span><span class="s">"Hello World!"</span><span class="p">)</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div data-tab-item="Bash" data-tab-group="default" 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">"Hello World!"</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<h2 id="config-example">Config example</h2>
|
||
<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">tabs</span> <span class="nx">groupId</span><span class="p">=</span><span class="s">"config"</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">"json"</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"> "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="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">"XML"</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"><Hello>World</Hello>
|
||
</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">"properties"</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">{{<</span> <span class="o">/</span><span class="nx">tabs</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div><p>Renders as:</p>
|
||
|
||
<div class="tab-panel">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="json"
|
||
data-tab-group="config"
|
||
class="tab-nav-button btn active"
|
||
onclick="switchTab('config','json')"
|
||
><span>json</span></button>
|
||
<button
|
||
data-tab-item="XML"
|
||
data-tab-group="config"
|
||
class="tab-nav-button btn "
|
||
onclick="switchTab('config','XML')"
|
||
><span>XML</span></button>
|
||
<button
|
||
data-tab-item="properties"
|
||
data-tab-group="config"
|
||
class="tab-nav-button btn "
|
||
onclick="switchTab('config','properties')"
|
||
><span>properties</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div data-tab-item="json" data-tab-group="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">"Hello"</span><span class="p">:</span> <span class="s2">"World"</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="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"><Hello></span>World<span class="nt"></Hello></span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div data-tab-item="properties" data-tab-group="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>
|
||
|
||
|
||
<div class="box notices warning">
|
||
<div class="box-label"><i class="fas fa-exclamation-triangle fa-fw"></i> Arrr</div>
|
||
<div class="box-content">
|
||
<p>When us'n tab views wit' different rrrambl'n sets, make sure t' use a common <code>groupId</code> fer equal sets but distinct
|
||
<code>groupId</code> fer different sets. Th' <code>groupId</code> defaults t' <code>'default'</code>.
|
||
<strong>Take this into account across th' whole ship!</strong>
|
||
Th' tab select'n be restored automatically based on th' <code>groupId</code> an' if it cannot find a tab item because it came
|
||
from th' <code>'default'</code> group on a different plank then all tabs will be empty at first.</p>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
</section>
|
||
</section>
|
||
</div>
|
||
</main>
|
||
</div>
|
||
<aside id="sidebar" class="default-animation showVisitedLinks">
|
||
<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="/hugo-theme-relearn/pir/">
|
||
<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 for="search-by"><i class="fas fa-search"></i></label>
|
||
<input data-search-input id="search-by" type="search" placeholder="Searrrch...">
|
||
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
||
</div>
|
||
<script src="/hugo-theme-relearn/js/lunr.min.js?1649711126"></script>
|
||
<script src="/hugo-theme-relearn/js/auto-complete.js?1649711126"></script>
|
||
<script src="/hugo-theme-relearn/js/search.js?1649711126"></script>
|
||
</div>
|
||
<div id="content-wrapper" class="highlightable">
|
||
<ul class="topics collapsible-menu">
|
||
<li data-nav-id="/hugo-theme-relearn/pir/basics/" title="Basics" class="dd-item"><input type="checkbox" id="section-182650db393a58ea8a0385f10a515d92" class="toggle"/><label for="section-182650db393a58ea8a0385f10a515d92" ></label><a href="/hugo-theme-relearn/pir/basics/"><b>1.</b> Basics<i class="fas fa-check read-icon"></i></a><ul>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/basics/requirements/" title="Requirrrements" class="dd-item"><a href="/hugo-theme-relearn/pir/basics/requirements/">Requirrrements<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/basics/installation/" title="Installat'n" class="dd-item"><a href="/hugo-theme-relearn/pir/basics/installation/">Installat'n<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/basics/migration/" title="Migrrrat'n" class="dd-item"><a href="/hugo-theme-relearn/pir/basics/migration/">Migrrrat'n<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/basics/configuration/" title="Configurrrat'n" class="dd-item"><a href="/hugo-theme-relearn/pir/basics/configuration/">Configurrrat'n<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/basics/customization/" title="Customizat'n" class="dd-item"><a href="/hugo-theme-relearn/pir/basics/customization/">Customizat'n<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/basics/generator/" title="Stylesheet generrrat'r" class="dd-item"><a href="/hugo-theme-relearn/pir/basics/generator/">Stylesheet generrrat'r<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/basics/history/" title="Historrry" class="dd-item"><a href="/hugo-theme-relearn/pir/basics/history/">Historrry<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/cont/" title="Rambl'n" class="dd-item"><input type="checkbox" id="section-4074c32ab128bf79d499f2f6ddf50674" class="toggle"/><label for="section-4074c32ab128bf79d499f2f6ddf50674" ></label><a href="/hugo-theme-relearn/pir/cont/"><b>2.</b> Rambl'n<i class="fas fa-check read-icon"></i></a><ul>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/cont/pages/" title="Planks orrrganizat'n" class="dd-item"><a href="/hugo-theme-relearn/pir/cont/pages/">Planks orrrganizat'n<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/cont/archetypes/" title="Arrrchetypes" class="dd-item"><a href="/hugo-theme-relearn/pir/cont/archetypes/">Arrrchetypes<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/cont/markdown/" title="Marrrkdown rules" class="dd-item"><a href="/hugo-theme-relearn/pir/cont/markdown/">Marrrkdown rules<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/cont/syntaxhighlight/" title="Code highlight'n" class="dd-item"><a href="/hugo-theme-relearn/pir/cont/syntaxhighlight/">Code highlight'n<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/cont/menushortcuts/" title="Menu extrrra shorrrtcuts" class="dd-item"><a href="/hugo-theme-relearn/pir/cont/menushortcuts/">Menu extrrra shorrrtcuts<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/cont/icons/" title="Ay'cons an' logos" class="dd-item"><a href="/hugo-theme-relearn/pir/cont/icons/">Ay'cons an' logos<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/cont/i18n/" title="Multilingual an' i18n" class="dd-item"><a href="/hugo-theme-relearn/pir/cont/i18n/">Multilingual an' i18n<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/cont/tags/" title="Tags" class="dd-item"><a href="/hugo-theme-relearn/pir/cont/tags/">Tags<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/" title="Shorrrtcodes" class="dd-item"><input type="checkbox" id="section-215953719902243a01571a1ede64aeeb" class="toggle"/><label for="section-215953719902243a01571a1ede64aeeb" ></label><a href="/hugo-theme-relearn/pir/shortcodes/"><b>3.</b> Shorrrtcodes<i class="fas fa-check read-icon"></i></a><ul>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/attachments/" title="Attachments" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/attachments/">Attachments<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/button/" title="Button" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/button/">Button<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/" title="Children" class="dd-item"><input type="checkbox" id="section-05de666a6804433386d9009e44fa7aa3" class="toggle"/><label for="section-05de666a6804433386d9009e44fa7aa3" ></label><a href="/hugo-theme-relearn/pir/shortcodes/children/">Children<i class="fas fa-check read-icon"></i></a><ul>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/test/" title="Plank X" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/children/test/">Plank X<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/children-1/" title="Plank 1" class="dd-item"><input type="checkbox" id="section-5c6c78bc0635ef1f61fdb91197081411" class="toggle"/><label for="section-5c6c78bc0635ef1f61fdb91197081411" ></label><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/">Plank 1<i class="fas fa-check read-icon"></i></a><ul>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/" title="Plank 1-1" class="dd-item alwaysopen"><input type="checkbox" id="section-be87ceb25a7988952eb9556a69f3cbdf" class="toggle" checked/><label for="section-be87ceb25a7988952eb9556a69f3cbdf" ></label><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/">Plank 1-1<i class="fas fa-check read-icon"></i></a><ul>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/" title="Plank 1-1-2" class="dd-item alwaysopen"><input type="checkbox" id="section-989ea17e090bb9681da73b58575dcced" class="toggle" checked/><label for="section-989ea17e090bb9681da73b58575dcced" ></label><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/">Plank 1-1-2<i class="fas fa-check read-icon"></i></a><ul>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/" title="Plank 1-1-2-1" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/">Plank 1-1-2-1<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/" title="Plank 1-1-2-2" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/">Plank 1-1-2-2<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/" title="Plank 1-1-3" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/">Plank 1-1-3<i class="fas fa-check read-icon"></i></a></li></ul></li></ul></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/children-2/" title="Plank 2" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/children/children-2/">Plank 2<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/children-3/" title="Plank 3" class="dd-item"><input type="checkbox" id="section-085f961452d7baa981ace00de789c321" class="toggle"/><label for="section-085f961452d7baa981ace00de789c321" ></label><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/">Plank 3<i class="fas fa-check read-icon"></i></a><ul>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/" title="Plank 3-1" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/children/children-3/test3/">Plank 3-1<i class="fas fa-check read-icon"></i></a></li></ul></li></ul></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/expand/" title="Expand" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/expand/">Expand<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/include/" title="Include" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/include/">Include<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/mermaid/" title="Merrrmaid" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/mermaid/">Merrrmaid<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/notice/" title="Notice" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/notice/">Notice<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/siteparam/" title="Ship param" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/siteparam/">Ship param<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/swagger/" title="Swaggerrr" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/swagger/">Swaggerrr<i class="fas fa-check read-icon"></i></a></li>
|
||
<li data-nav-id="/hugo-theme-relearn/pir/shortcodes/tabs/" title="Tabbed views" class="dd-item"><a href="/hugo-theme-relearn/pir/shortcodes/tabs/">Tabbed views<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||
</ul>
|
||
<div id="shortcuts">
|
||
<div class="nav-title">Morrre</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="/hugo-theme-relearn/pir/more/showcase/"><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> Cap'n Hugo Documentat'n</a></li>
|
||
<li><a class="padding" href="/hugo-theme-relearn/pir/more/credits/"><i class='fas fa-fw fa-bullhorn'></i> Crrredits</a></li>
|
||
<li><a class="padding" href="/hugo-theme-relearn/pir/tags/"><i class='fas fa-fw fa-tags'></i> Arrr! 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">
|
||
<a class="padding select-container">
|
||
<i class="fas fa-language fa-fw"></i>
|
||
<span> </span>
|
||
<div class="select-style">
|
||
<select id="select-language" onchange="location = baseUri + this.value;">
|
||
<option id="pir" value="/hugo-theme-relearn/pir/" selected>Arrr! ☠ Pirrrates ☠</option>
|
||
<option id="en" value="/hugo-theme-relearn/">English</option>
|
||
</select>
|
||
</div>
|
||
<div class="select-clear"></div>
|
||
</a>
|
||
</li>
|
||
<li id="select-variant-container" class="footerVariantSwitch showVariantSwitch">
|
||
<a class="padding select-container">
|
||
<i class="fas fa-paint-brush fa-fw"></i>
|
||
<span> </span>
|
||
<div class="select-style">
|
||
<select id="select-variant" onchange="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>
|
||
</a>
|
||
<script>variants.markSelectedVariant();</script>
|
||
</li>
|
||
<li class="footerVisitedLinks showVisitedLinks"><a class="padding" href="#" data-clear-history-toggle=""><i class="fas fa-history fa-fw"></i> Clear Historrry</a></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"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
|
||
<script async defer src="/hugo-theme-relearn/js/buttons.js?1649711126"></script>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
<script src="/hugo-theme-relearn/js/clipboard.min.js?1649711126"></script>
|
||
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1649711126"></script>
|
||
<script src="/hugo-theme-relearn/js/featherlight.min.js?1649711126"></script>
|
||
<script src="/hugo-theme-relearn/js/theme.js?1649711126"></script>
|
||
</body>
|
||
</html>
|