mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 18:53:18 +00:00
9276 lines
778 KiB
HTML
9276 lines
778 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="pir" dir="rtl">
|
||
<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.120.4">
|
||
<meta name="generator" content="Relearn 5.23.2+tip">
|
||
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
||
<meta name="author" content="Sören Weber">
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png">
|
||
<meta name="twitter:title" content="Cap'n Hugo Relearrrn Theme">
|
||
<meta name="twitter:description" content="Documentation for Hugo Relearn Theme">
|
||
<meta property="og:title" content="Cap'n Hugo Relearrrn Theme">
|
||
<meta property="og:description" content="Documentation for Hugo Relearn Theme">
|
||
<meta property="og:type" content="website">
|
||
<meta property="og:url" content="https://McShelby.github.io/hugo-theme-relearn/pir/index.html">
|
||
<meta property="og:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png">
|
||
<meta property="og:site_name" content="Cap'n Hugo Relearrrn Theme">
|
||
<title>Cap'n Hugo Relearrrn Theme</title>
|
||
<link href="https://McShelby.github.io/hugo-theme-relearn/index.html" rel="alternate" hreflang="x-default">
|
||
<link href="https://McShelby.github.io/hugo-theme-relearn/index.html" rel="alternate" hreflang="en">
|
||
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/index.html" rel="alternate" hreflang="pir">
|
||
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/index.html" rel="canonical" type="text/html" title="Cap'n Hugo Relearrrn Theme">
|
||
<link href="../pir/index.xml" rel="alternate" type="application/rss+xml" title="Cap'n Hugo Relearrrn Theme">
|
||
<link href="../images/logo.svg?1700353943" rel="icon" type="image/svg+xml">
|
||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||
<link href="../css/fontawesome-all.min.css?1700353946" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fontawesome-all.min.css?1700353946" rel="stylesheet"></noscript>
|
||
<link href="../css/nucleus.css?1700353946" rel="stylesheet">
|
||
<link href="../css/auto-complete.css?1700353946" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/auto-complete.css?1700353946" rel="stylesheet"></noscript>
|
||
<link href="../css/perfect-scrollbar.min.css?1700353946" rel="stylesheet">
|
||
<link href="../css/fonts.css?1700353946" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fonts.css?1700353946" rel="stylesheet"></noscript>
|
||
<link href="../css/theme.css?1700353946" rel="stylesheet">
|
||
<link href="../css/theme-auto.css?1700353946" rel="stylesheet" id="R-variant-style">
|
||
<link href="../css/variant.css?1700353946" rel="stylesheet">
|
||
<link href="../css/print.css?1700353946" rel="stylesheet" media="print">
|
||
<link href="../css/format-print.css?1700353946" rel="stylesheet">
|
||
<link href="../css/ie.css?1700353946" rel="stylesheet">
|
||
<script src="../js/url.js?1700353946"></script>
|
||
<script src="../js/variant.js?1700353946"></script>
|
||
<script>
|
||
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
|
||
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
|
||
window.index_js_url="../pir/index.search.js";
|
||
var root_url="../";
|
||
var baseUri=root_url.replace(/\/$/, '');
|
||
window.relearn = window.relearn || {};
|
||
window.relearn.baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||
// variant stuff
|
||
window.variants && variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
|
||
// translations
|
||
window.T_Copy_to_clipboard = `Copy t' clipboard`;
|
||
window.T_Copied_to_clipboard = `Copied t' clipboard!`;
|
||
window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
|
||
window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
|
||
window.T_Reset_view = `Rrreset view`;
|
||
window.T_View_reset = `View rrreset!`;
|
||
window.T_No_results_found = `No rrresults found fer "{0}"`;
|
||
window.T_N_results_found = `{1} rrresults found fer "{0}"`;
|
||
</script>
|
||
<style>
|
||
#R-body img.bg-white {
|
||
background-color: white;
|
||
}
|
||
</style>
|
||
</head>
|
||
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../pir/index.html">
|
||
<div id="R-body" class="default-animation">
|
||
<div id="R-body-overlay"></div>
|
||
<nav id="R-topbar">
|
||
<div class="topbar-wrapper">
|
||
<div class="topbar-sidebar-divider"></div>
|
||
<div class="topbar-area topbar-area-start" data-area="start">
|
||
<div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide">
|
||
<button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL+ALT+n)">
|
||
<i class="fa-fw fas fa-bars"></i>
|
||
</button>
|
||
</div>
|
||
</div>
|
||
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList">
|
||
</ol>
|
||
<div class="topbar-area topbar-area-end" data-area="end">
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
<div id="R-main-overlay"></div>
|
||
<main id="R-body-inner" class="highlightable home" tabindex="-1">
|
||
<div class="flex-block-wrapper">
|
||
<article class="home">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="capn-hugo-relearrrn-theme">Cap'n Hugo Relearrrn Theme</h1>
|
||
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Arrr! Pirrrates</div>
|
||
<div class="box-content">
|
||
|
||
<p>Fello' pirrrates, grog made us dizzy! Be awarrre <b>some stuff may look weird</b> in this trrranslat'n. Like <b>Merrrmaids</b>, do'n <b>math or chemistrrry</b> and stuff.</p>
|
||
</div>
|
||
</div>
|
||
<p>A theme fer <a href="https://gohugo.io/" target="_blank">Cap'n Hugo</a> designed fer documentat'n.</p>
|
||
<p><a href="../basics/migration/index.html">★ What’s new 'n th' latest release ★</a></p>
|
||
<p><a href="#R-image-4b6aab1e18ca337c501551f54b210aa9" class="lightbox-link"><img src="../images/hero.png?width=100%25&height=100%25" alt="Image o' th' Relearrrn theme 'n light an' dark mode on phone, tablet an' desktop" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: auto;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-4b6aab1e18ca337c501551f54b210aa9"><img src="../images/hero.png?width=100%25&height=100%25" alt="Image o' th' Relearrrn theme 'n light an' dark mode on phone, tablet an' desktop" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
<h2 id="motivation">Motivat'n</h2>
|
||
<p>Th' theme be a fork o' th' great <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learrrn theme</a> wit' th' aim o' fix'n long outstand'n bugs an' adapt'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>
|
||
<h2 id="features">Features</h2>
|
||
<ul>
|
||
<li><strong>Wide set o' usage scenarios</strong>
|
||
<ul>
|
||
<li>Responsive design fer mobile usage</li>
|
||
<li>Looks nice on paper (if it has to)</li>
|
||
<li>Us'ble offline, no external dependencies</li>
|
||
<li><a href="../basics/configuration/index.html#serving-your-page-from-the-filesystem">Us'ble from yer local file system via <code>file://</code> protocol</a></li>
|
||
<li>Support fer th' <a href="https://github.com/estruyf/vscode-front-matter" target="_blank">VSCode Front Matter extension</a> fer on-premise CMS capabilities</li>
|
||
<li>Support fer Internet Explorer 11</li>
|
||
<li><a href="../basics/configuration/index.html#social-media-meta-tags">Support fer Open Graph an' Twitter Cards</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Configur'ble them'n an' visuals</strong>
|
||
<ul>
|
||
<li><a href="../basics/customization/index.html#change-the-logo">Configur'ble brand images</a></li>
|
||
<li><a href="../basics/customization/index.html#adjusting-to-os-settings">Automatic switch fer light/dark variant dependend on yer OS sett'ns</a></li>
|
||
<li>Predefined light, dark an' color variants</li>
|
||
<li><a href="../basics/customization/index.html#multiple-variants">User select'ble variants</a></li>
|
||
<li><a href="../basics/generator/index.html">Stylesheet generator</a></li>
|
||
<li><a href="../shortcodes/highlight/index.html">Configur'ble rules highlight'n</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Unique theme features</strong>
|
||
<ul>
|
||
<li><a href="../basics/configuration/index.html#activate-print-support">Print whole chapters or even th' complete ship</a></li>
|
||
<li>In plank search</li>
|
||
<li><a href="../basics/configuration/index.html#activate-search">Ship search</a></li>
|
||
<li><a href="../basics/configuration/index.html#activate-dedicated-search-page">Dedicated search plank</a></li>
|
||
<li><a href="../cont/taxonomy/index.html">Taxonomy support</a></li>
|
||
<li><a href="../basics/topbar/index.html">Configur'ble topbar buttons</a></li>
|
||
<li><a href="../cont/pages/index.html">Unlimited nested menu items</a></li>
|
||
<li><a href="../cont/menushortcuts/index.html">Configur'ble shortcut links</a></li>
|
||
<li>Hidden planks</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Multi language support</strong>
|
||
<ul>
|
||
<li><a href="../cont/i18n/index.html">Full support fer languages written right t' left</a></li>
|
||
<li><a href="../cont/i18n/index.html#basic-configuration">Avail'ble languages</a>: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese</li>
|
||
<li><a href="../cont/i18n/index.html#search">Search support fer mixed language rrrambl'n</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Additional Marrrkdown features</strong>
|
||
<ul>
|
||
<li><a href="../cont/markdown/index.html">Support fer GFM (GitHub Flavored Markdown)</a></li>
|
||
<li><a href="../cont/markdown/index.html#image-effects">Image effects like siz'n, shadow, border an' alignment</a></li>
|
||
<li><a href="../cont/markdown/index.html#lightbox">Image lightbox</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Shorrrtcodes galore</strong>
|
||
<ul>
|
||
<li><a href="../shortcodes/attachments/index.html">Display files attached t' plank bundles</a></li>
|
||
<li><a href="../shortcodes/badge/index.html">Marker badges</a></li>
|
||
<li><a href="../shortcodes/button/index.html">Configur'ble buttons</a></li>
|
||
<li><a href="../shortcodes/children/index.html">List child planks</a></li>
|
||
<li><a href="../shortcodes/expand/index.html">Expand areas t' reveal rrrambl'n</a></li>
|
||
<li><a href="../shortcodes/icon/index.html">Font Awesome ay'cons</a></li>
|
||
<li><a href="../shortcodes/include/index.html">Inclusion o' other files</a></li>
|
||
<li><a href="../shortcodes/math/index.html">Math an' chemical formulae us'n MathJax</a></li>
|
||
<li><a href="../shortcodes/mermaid/index.html">Merrrmaid diagrams fer flowcharts, sequences, gantts, pie, etc.</a></li>
|
||
<li><a href="../shortcodes/notice/index.html">Colorful boxes</a></li>
|
||
<li><a href="../shortcodes/openapi/index.html">OpenAPI specificat'ns us'n Swagger UI</a></li>
|
||
<li><a href="../shortcodes/siteparam/index.html">Reveal ye site’s configurat'n parameter</a></li>
|
||
<li><a href="../shortcodes/tab/index.html">Single tabbed panels</a> an' <a href="../shortcodes/tabs/index.html">multiple tabbed panels</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id="support">Support</h2>
|
||
<p>T' get support, feel free t' open a new <a href="https://github.com/McShelby/hugo-theme-relearn/discussions" target="_blank">discussion topic</a> or <a href="https://github.com/McShelby/hugo-theme-relearn/issues" target="_blank">issue report</a> 'n th' official repository on GitHub.</p>
|
||
<h2 id="contributions">Contribut'ns</h2>
|
||
<p>Feel free t' contribute t' this documentat'n by just click'n th'
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-pen"></i>
|
||
|
||
</button>
|
||
</span> <em>edit</em> button displayed on top right o' each plank.</p>
|
||
<p>Ye be most welcome t' contribute bugfixes or new features by mak'n pull requests t' th' <a href="https://github.com/McShelby/hugo-theme-relearn" target="_blank">official repository</a>. Check th' <a href="../dev/contributing/index.html">contribut'n guidelines</a> first before start'n.</p>
|
||
<h2 id="license">License</h2>
|
||
<p>Th' Relearrrn theme be licensed under th' <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE" target="_blank">MIT License</a>.</p>
|
||
<h2 id="credits">Credits</h2>
|
||
<p>This theme would not be poss'ble without th' work o' <a href="../more/credits/index.html">many others</a>.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsct'ns o' Cap'n Hugo Relearrrn Theme</h1>
|
||
<article class="chapter">
|
||
<header class="headline">
|
||
</header>
|
||
<div class="article-subheading">T' chapterrr 1</div>
|
||
<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>
|
||
<h1 class="a11y-only">Subsct'ns o' Basics</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="whats-new">What's New</h1>
|
||
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Arrr! Pirrrates</div>
|
||
<div class="box-content">
|
||
|
||
<p>Fello' pirrrates, grog made us dizzy! Be awarrre <b>some stuff may look weird</b> in this trrranslat'n. Like <b>Merrrmaids</b>, do'n <b>math or chemistrrry</b> and stuff.</p>
|
||
</div>
|
||
</div>
|
||
<p>This document shows ye what’s new 'n th' latest release an' flags it wit' one o' th' follow'n badges. For a detailed list o' changes, see th' <a href="../basics/history/index.html">history plank</a>.</p>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.95.0</span></span> Th' minimum required Cap'n Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> A change that requires act'n by ye after upgrad'n t' assure th' ship be still functional.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> A change 'n default behavior that may requires act'n by ye if ye want t' revert it.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Marks new behavior ye might find interest'n or comes configur'ble.</p>
|
||
</li>
|
||
</ul>
|
||
<!--GH-ACTION-RELEASE-MILESTONE-->
|
||
<hr>
|
||
<h2 id="5240">5.24.0.beta</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' light themes have a bit more contrast fer rrrambl'n text an' head'ns. Also th' syntaxhighlight'n was changed t' th' more colorful MonokaiLight. This br'ns th' syntaxhighlightn'n 'n sync wit' th' correspond'n dark theme variants, which be us'n Monokai.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5230">5.23.0 (2023-11-03)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Wit' <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.120.0</span></span> th' author sett'ns move into th' <code>[params]</code> array 'n yer <code>config.toml</code>. Because this collides wit' th' previous way, th' theme expected author informat'n, it now adheres t' Cap'n Hugo standards an' prints out a warning dur'n built if someth'n be wrong.</p>
|
||
<p>Change yer previous sett'n from</p>
|
||
<div class="wrap-code 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">author</span> <span class="p">=</span> <span class="s2">"Hugo"</span></span></span></code></pre></div><p>t'</p>
|
||
<div class="wrap-code 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">author</span><span class="p">.</span><span class="nx">name</span> <span class="p">=</span> <span class="s2">"Hugo"</span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Taxonomy <a href="https://gohugo.io/content-management/taxonomies/#add-custom-metadata-to-a-taxonomy-or-term" target="_blank">term planks</a> now add th' breadcrumb fer each listed plank. If this gets too crowded fer ye, ye can turn th' breadcrumbs off 'n yer <code>config.toml</code> by add'n <code>disableTermBreadcrumbs=true</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Taxonomy an' term planks be now allowed t' contain rrrambl'n. This be added inbetween th' title an' th' plank list.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> It be now poss'ble t' print custom taxonomies anywhere 'n yer plank. <a href="../cont/taxonomy/index.html#customization">See th' docs</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> It be now poss'ble t' adjust th' menu width fer yer whole ship. <a href="../basics/customization/index.html#change-the-menu-width">See th' docs</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release adds social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. <a href="../basics/configuration/index.html#social-media-meta-tags">See th' docs</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release comes wit' additional sort opt'ns fer th' menu an' th' <a href="../shortcodes/children/index.html"><code>children</code> shortcode</a>. Both will now accept th' follow'n values: <code>weight</code>, <code>title</code>, <code>linktitle</code>, <code>modifieddate</code>, <code>expirydate</code>, <code>publishdate</code>, <code>date</code>, <code>length</code> or <code>default</code> (adher'n t' Hugo’s default sort order).</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme now provides a mechanism t' board further JavaScript dependencies defined by ye only if it be needed. This comes 'n handy if ye want t' add own shorrrtcodes that depend on additional JavaScript code t' be boarded. <a href="../basics/customization/index.html#own-shortcodes-with-javascript-dependencies">See th' docs</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme has updated its Merrrmaid dependency t' 10.6.0. This adds support fer th' <a href="../shortcodes/mermaid/index.html#xychart">xychart type</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release adds port'ble Marrrkdown links.</p>
|
||
<p>Previously it was not poss'ble t' use pure Marrrkdown links 'n a configurat'n independend way t' link t' planks inside o' yer project. It always required ye t' know how yer <code>uglyURLs</code> sett'n be, wheather ye link t' a plank or plank bundle an' 'n case o' relative links if yer current plank be a plank or plank bundle. (eg. <code>[generator](generator/index.html)</code> vs. <code>[generator](generator.html)</code>). This be a hassle as ye have t' change these links manually once ye change yer <code>uglyURLs</code> sett'n or change th' type o' a plank.</p>
|
||
<p>Ye could work around this by us'n th' <code>relref</code> shortcode (eg <code>[generator]({{% relref "../generator" %}})</code>) which works but results 'n non-port'ble Marrrkdown.</p>
|
||
<p>Now it’s poss'ble t' use th' same path o' a call t' <code>relref</code> 'n a plain Marrrkdown link (eg <code>[generator](../generator)</code>). This be independend o' any configurat'n sett'ns or th' plank types involved 'n link'n. Avast, that this requires yer links t' be given without any extension, so <code>[generator](generator/index.html)</code> will work as before.</p>
|
||
<p>Th' follow'n types o' link'n be supported:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>link</th>
|
||
<th>descript'n</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code>[generator](en/basics/generator)</code></td>
|
||
<td>absolute from yer project root (multilang)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>[generator](/en/basics/generator)</code></td>
|
||
<td>absolute from yer project root (multilang)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>[generator](basics/generator)</code></td>
|
||
<td>absolute from yer current language root</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>[generator](/basics/generator)</code></td>
|
||
<td>absolute from yer current language root</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>[generator](./../generator)</code></td>
|
||
<td>relative from th' current plank</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>[generator](../generator)</code></td>
|
||
<td>relative from th' current plank</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5220">5.22.0 (2023-10-02)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> This release fixes an issue whar' 'n unfortunate condit'ns DOM ids generated by Cap'n Hugo may collide wit' DOM ids set by th' theme. T' avoid this, all theme DOM ids be now prefixed wit' <code>R-</code>.</p>
|
||
<p>If ye haven’t modified anyth'n, everyth'n be fine. Otherwise ye have t' check yer custom CSS rules an' JavaScript code.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Ye can now have structural sections 'n th' hierarchical menu without generat'n a plank fer it.</p>
|
||
<p>This can come 'n handy, if rrrambl'n fer such a section plank doesn’t make much sense t' ye. See <a href="../cont/pages/index.html#disable-section-pages">th' documentat'n</a> fer how t' do this.</p>
|
||
<p>This feature may require ye t' make changes t' yer exist'n installat'n if ye be already us'n <em><a href="../cont/menushortcuts/index.html#shortcuts-to-pages-inside-of-your-project">shortcuts t' planks inside o' yer project</a></em> wit' a <em>headless branch parent</em>.</p>
|
||
<p>In this case it be advised t' remove th' <code>title</code> from th' headless branch parent’s frontmatter, as it will otherwise appear 'n yer breadcrumbs.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> It be now poss'ble t' overwrite th' sett'n fer <code>collapsibleMenu</code> o' yer <code>config.toml</code> inside o' a page’s frontmatter.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> If a Merrrmaid graph be zoom'ble a button t' reset th' view be now added t' th' upper right corner. Th' button be only shown once th' mouse be moved over th' graph.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> It be now poss'ble t' remove th' root breadcrumb by sett'n <code>disableRootBreadcrumb=true</code> 'n yer <code>config.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' output o' th' dedicated search plank now displays th' result’s breadcrumb.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> T'ble rows now change their background color on every even row.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translat'n into Swahili. This language be not supported fer search.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5210">5.21.0 (2023-09-18)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> We made changes t' th' menu footer t' improve alignment wit' th' menu items 'n most cases. Care was taken not t' break yer exist'n overwritten footer. Anyways, if ye have yer <code>menu-footer.html</code> <a href="../basics/customization/index.html">partial overridden</a>, ye may want t' review th' styl'n (eg. margins/paddings) o' yer partial.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release comes wit' an awesome new feature, that allows ye t' cust'mize yer topbar buttons, change behavior, reorder them or define entirely new ones, unique t' yer installat'n. See <a href="../basics/topbar/index.html">th' documentat'n</a> fer further details.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme has updated its Swagger dependency t' 5.7.2 fer th' <a href="../shortcodes/openapi/index.html"><code>openapi</code> shortcode</a>. This br'ns support fer OpenAPI Specificat'n 3.1.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5200">5.20.0 (2023-08-26)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' theme has updated its Swagger dependency t' 5.4.1 fer th' <a href="../shortcodes/openapi/index.html"><code>openapi</code> shortcode</a>.</p>
|
||
<p>Wit' this comes a change 'n th' light theme variants o' <code>Relearrrn Bright</code>, <code>Relearrrn Light</code> an' <code>Zen Light</code> by switch'n th' syntaxhighlightn'n inside o' openapi t' a light scheme. This br'ns it more 'n sync wit' th' code style used by th' theme variants itself.</p>
|
||
<p>Additionally, th' syntaxhighlightn'n inside o' openapi fer print'n was switched t' a light scheme fer all theme variants.</p>
|
||
<p>If ye dislike this change, ye can revert this 'n yer theme variants CSS by add'n</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="line"><span class="cl"><span class="nt">--OPENAPI-CODE-theme</span><span class="o">:</span> <span class="nt">obsidian</span><span class="o">;</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nt">--PRINT-OPENAPI-CODE-theme</span><span class="o">:</span> <span class="nt">obsidian</span><span class="o">;</span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> For consistency reasons, we renamed th' CSS vari'ble <code>--MENU-SECTION-HR-color</code> t' <code>--MENU-SECTION-SEPARATOR-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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme variants <code>Zen Light</code> an' <code>Zen Dark</code> now add more contrast between menu, topbar an' rrrambl'n by add'n thin borders.</p>
|
||
<p>Those borders be now configur'ble by us'n th' CSS variables <code>--MAIN-TOPBAR-BORDER-color</code>, <code>--MENU-BORDER-color</code>, <code>--MENU-TOPBAR-BORDER-color</code>, <code>--MENU-TOPBAR-SEPARATOR-color</code>, <code>--MENU-HEADER-SEPARATOR-color</code> an' <code>--MENU-SECTION-ACTIVE-CATEGORY-BORDER-color</code>.</p>
|
||
<p>For exist'n variants noth'n has changed visually.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' default values fer th' <a href="../cont/markdown/index.html#image-effects">image effects</a> be <a href="../cont/imageeffects/index.html">now configur'ble</a> fer yer whole ship via <code>config.toml</code> or fer each plank thru frontmatter.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release fixes a long outstand'n bug whar' Merrrmaid graphs could not be displayed if they were initially hidden - like 'n collapsed <code>expand</code> or inactive <code>tabs</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Restored compatibility wit' Cap'n Hugo versions lower than <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.111.0</span></span> fer th' <a href="../shortcodes/highlight/index.html"><code>highlight</code> shortcode</a>. This does not change th' minimum required Cap'n Hugo version.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5190">5.19.0 (2023-08-12)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../shortcodes/highlight/index.html"><code>highlight</code> shortcode</a> now accepts th' new parameter <code>title</code>. This displays th' code like a <a href="../shortcodes/tab/index.html">single tab</a>. This be also avail'ble us'n codefences an' makes it much easier t' write nicer code samples.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme has added two new color variants <code>zen-light</code> an' <code>zen-dark</code>. Check it out!</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme now <a href="../basics/customization/index.html#javascript">dispatches th' custom event</a> <code>themeVariantLoaded</code> on th' <code>document</code> when th' variant be fully boarded either initially or by switch'n th' variant manually wit' th' variant selector.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme has updated its Merrrmaid dependency t' 10.3.1. This adds support fer th' <a href="../shortcodes/mermaid/index.html#sankey">sankey diagram type</a> an' now comes wit' full support fer YAML inside Merrrmaid graphs (previously, th' theme ignored explicit Merrrmaid theme sett'ns 'n YAML).</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translat'n into Hungarian.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5180">5.18.0 (2023-07-27)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' theme adds additional warnings fer deprecated or now unsupported features. Th' warnings include hints how t' fix them an' an additional link t' th' documenat'n.</p>
|
||
<p><code>DEPRECATION</code> warnings mark features that still work but may be removed 'n th' future.</p>
|
||
<p><code>UNSUPPORTED</code> warnings mark features that will not work anymore.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> There be visual improvements 'n display'n text links 'n yer rrrambl'n aswell as t' some other click'ble areas 'n th' theme. If you’ve overwritten some theme styles 'n yer own CSS, keep this 'n mind.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Restored compatibility wit' Cap'n Hugo <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.95.0</span></span> or higher. This does not change th' minimum required Cap'n Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../shortcodes/siteparam/index.html"><code>siteparam</code> shortcode</a> be now cap'ble 'n display'n nested params aswell as support'n text formatt'n.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5170">5.17.0 (2023-06-22)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' default behavior fer th' copy-to-clipboard feature fer code blocks has changed.</p>
|
||
<p>Th' copy-to-clipboard button fer code blocks will now only be displayed if th' reader hovers th' code block.</p>
|
||
<p>If ye dislike this new behavior ye can turn it off an' revert t' th' old behavior by add'n <code>[params] disableHoverBlockCopyToClipBoard=true</code> t' yer <code>config.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Restored compatibility wit' Cap'n Hugo <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.114.0</span></span> or higher. This does not change th' minimum required Cap'n Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new <a href="../shortcodes/highlight/index.html"><code>highlight</code> shortcode</a> replaces Hugo’s default implementat'n an' be fully compat'ble. So ye don’t need t' change anyth'n.</p>
|
||
<p>In addit'n it offers some extensions. Currently only th' <code>wrap</code> extension opt'n be provided t' control whether a code block should be wrapped or scrolled if t' long t' fit.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5160">5.16.0 (2023-06-10)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' theme now provides warnings fer deprecated or now unsupported features. Th' warnings include hints how t' fix them an' an additional link t' th' documenat'n.</p>
|
||
<p><code>DEPRECATION</code> warnings mark features that still work but may be removed 'n th' future.</p>
|
||
<p><code>UNSUPPORTED</code> warnings mark features that will not work anymore.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' 404 error plank was revamped. Hopefully ye will not see this very often.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../shortcodes/tabs/index.html"><code>tabs</code> shortcode</a> an' th' <a href="../shortcodes/tab/index.html"><code>tab</code> shortcode</a> received some love an' now align wit' their style, color, title an' ay'con parameter t' th' other shorrrtcodes.</p>
|
||
<p>Th' visuals be now slightly different compared t' previous versions. Most note'ble, if ye now display a single code block 'n a tab, its default styl'n will adapt t' that o' a code block but wit' a tab handle at th' top.</p>
|
||
<p>Additionally th' <code>name</code> parameter was renamed t' <code>title</code> but ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. Nevertheless ye will get deprecat'n warnings while execut'n Hugo.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme now optionally supports <a href="../basics/customization/index.html#change-the-favicon">separate favicons</a> fer light & dark mode.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5150">5.15.0 (2023-05-29)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Restored compatibility wit' Cap'n Hugo <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.112.0</span></span> or higher. This does not change th' minimum required Cap'n Hugo version.</p>
|
||
<p>Th' <a href="../shortcodes/attachments/index.html"><code>attachments</code> shortcode</a> has compatiblity issues wit' newer Cap'n Hugo versions. Ye must switch t' leaf bundles or be locked t' Cap'n Hugo < <code>0.112.0</code> fer now.</p>
|
||
<p>It be <a href="https://github.com/McShelby/hugo-theme-relearn/issues/22" target="_blank">planned t' refactor</a> th' <code>attchments</code> shortcode 'n th' future. This will make it poss'ble t' use th' shortcode 'n branch bundles again but not 'n simple planks anymore. This will most likely come wit' a break'n change.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' <a href="../shortcodes/tabs/index.html"><code>tabs</code> shortcode</a> has changed behavior if ye haven’t set th' <code>groupid</code> parameter.</p>
|
||
<p>Formerly all tab views without a <code>groupid</code> were treated as so they belong t' th' same group. Now, each tab view be treated as it was given a unique id.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' already known <code>tabs</code>has a new friend th' <a href="../shortcodes/tab/index.html"><code>tab</code> shortcode</a> t' make it easier t' create a tab view 'n case ye only need one single tab. Really handy if ye want t' flag yer code examples wit' a language identifier.</p>
|
||
<p>Additionally fer such a use case, th' whitespace between a tab outline an' th' code be removed if only a single code block be contained.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Besides th' <em>tag</em> <a href="../cont/taxonomy/index.html">taxonomy</a> th' theme now also provides th' <em>category</em> taxonomy out o' th' box an' shows them 'n th' rrrambl'n footer o' each plank.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5140">5.14.0 (2023-05-20)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' taxonomy planks received some love 'n this release, mak'n them better leverage avail'ble screen space an' add'n translat'n support fer th' taxonomy names.</p>
|
||
<p>Hugo’s default taxonmies <code>tags</code> an' <code>categories</code> be already contained 'n th' theme’s i18n files. If ye have self-defined taxonomies, ye can add translat'ns by add'n them t' yer own i18n files. If ye don’t provide translat'ns, th' singualar an' plural forms be taken as configured 'n yer <code>config.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> T' give ye more flexibility 'n customiz'n yer article layout a new partial <code>content-header.html</code> be introduced.</p>
|
||
<p>This came out o' th' requirement t' cust'mize th' posit'n o' article tags, which by default be displayed above th' title. A second requirement was t' also show additional <a href="https://gohugo.io/content-management/taxonomies/" target="_blank">taxonomies</a> not supported by th' theme natively. While Cap'n Hugo supports tags an' categories by default, th' theme only displays tags.</p>
|
||
<p>So how t' adjust th' posit'n o' tags start'n from th' theme’s default whar' tags be only shown above th' title?</p>
|
||
<ol>
|
||
<li>Hide tags above title: Overwrite <code>content-header.html</code> wit' an empty file.</li>
|
||
<li>Show tags between title an' rrrambl'n: Overwrite <code>heading-post.html</code> an' add <code>{{- partial "tags.html" . }}</code> t' it.</li>
|
||
<li>Show tags below rrrambl'n: Overwrite <code>content-footer.html</code> an' add <code>{{- partial "tags.html" . }}</code> t' it.</li>
|
||
</ol>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new parameter <code>breadcrumbSeparator</code> be now avail'ble 'n yer <code>config.toml</code> t' change th' - well - separator o' th' breadcrumb items. An appropriate default be 'n place if ye do not configure anyth'n.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5130">5.13.0 (2023-05-17)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' <code>swagger</code> shortcode was deprecated 'n favor fer th' <a href="../shortcodes/openapi/index.html"><code>openapi</code> shortcode</a>. Ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. It be planned t' remove th' <code>swagger</code> shortcode 'n th' next major release.</p>
|
||
<p>Additionally, th' implemant'n o' this shortcode was switched from RapiDoc t' <a href="https://github.com/swagger-api/swagger-ui" target="_blank">SwaggerUI</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5120">5.12.0 (2023-05-04)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed (again). While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Support fer th' great <a href="https://github.com/estruyf/vscode-front-matter" target="_blank">VSCode Front Matter extension</a> which provides on-premise CMS capabilties t' Cap'n Hugo.</p>
|
||
<p>Th' theme provides Front Matter snippets fer its shorrrtcodes. Currently only English an' German be supported. Put a reference into yer <code>frontmatter.json</code> like this</p>
|
||
<div class="wrap-code 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="err">...</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"frontMatter.extends"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"./vscode-frontmatter/snippets.en.json"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="err">...</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Support fer languages that be written right t' left (like Arabic) be now complete an' extended t' th' menu, th' top navigat'n bar an' print. Ye can experience this 'n th' <a href="../pir/index.html">pirate translat'n</a>. This feature be not avail'ble 'n Internet Explorer 11.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' scrollbars be now colored accord'n t' their variant color scheme t' better fit into th' visuals.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5110">5.11.0 (2023-02-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' theme removed th' popular <a href="https://jquery.com" target="_blank">jQuery</a> library from its distribut'n.</p>
|
||
<p>In case ye made changes t' th' theme that be dependend on this library ye can place a copy o' jQuery into yer <code>static/js</code> directory an' board it from yer own <code>layouts/partials/custom-header.html</code> like this:</p>
|
||
<div class="wrap-code 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">script</span> <span class="na">src</span><span class="o">=</span><span class="s">"{{"</span><span class="na">js</span><span class="err">/</span><span class="na">jquery</span><span class="err">.</span><span class="na">min</span><span class="err">.</span><span class="na">js</span><span class="err">"|</span> <span class="na">relURL</span><span class="err">}}"</span> <span class="na">defer</span><span class="p">></</span><span class="nt">script</span><span class="p">></span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> <a href="../shortcodes/mermaid/index.html#parameter">Merrrmaid</a> diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.</p>
|
||
<p>Th' default sett'n o' <code>on</code>, 'n effect since 1.1.0, changed back t' <code>off</code> as there was interference wit' scroll'n on mobile an' big planks.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' theme be now cap'ble t' visually <a href="../basics/customization/index.html#adjust-to-os-settings">adapt t' yer OS’s light/dark mode sett'n</a>.</p>
|
||
<p>This be also th' new default sett'n if ye haven’t configured <code>themeVariant</code> 'n yer <code>config.toml</code>.</p>
|
||
<p>Additionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new <code>themeVariantAuto</code> parameter.</p>
|
||
<p>This be not supported fer Internet Explorer 11, which still displays 'n th' <code>relearn-light</code> variant.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' JavaScript code fer handl'n image lightboxes (provided by <a href="https://noelboss.github.io/featherlight" target="_blank">Featherlight</a>) was replaced by a CSS-only solut'n.</p>
|
||
<p>This also changed th' <a href="../cont/markdown/index.html#lightbox">lightbox effects</a> parameter from <code>featherlight=false</code> t' <code>lightbox=false</code>. Nevertheless ye don’t need t' change anyth'n as th' old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' <a href="../shortcodes/expand/index.html"><code>expand</code> shortcode</a> was changed. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translat'n into Czech. This language be not supported fer search.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="https://github.com/McShelby/hugo-theme-relearn/tags" target="_blank">GitHub releases</a> be also now tagged fer th' main version (eg. <code>1.2.x</code>), major version (eg. <code>1.x</code>) an' th' latest (just <code>x</code>) release mak'n it easier fer ye t' pin th' theme t' a certain version.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5100">5.10.0 (2023-01-25)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../shortcodes/attachments/index.html"><code>attachments</code></a>, <a href="../shortcodes/badge/index.html"><code>badge</code></a>, <a href="../shortcodes/button/index.html"><code>button</code></a> an' <a href="../shortcodes/notice/index.html"><code>notice</code></a> shorrrtcodes have a new parameter <code>color</code> t' set arbitrary CSS color values.</p>
|
||
<p>Additionally th' <code>--ACCENT-color</code> brand color introduced 'n version 5.8.0 be now supported wit' these shorrrtcodes.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="590">5.9.0 (2022-12-23)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> Wit' this version it be now poss'ble t' not only have sections on th' first menu level but also planks.</p>
|
||
<p>It was later discovered, that this causes planks only meant t' be displayed 'n th' <code>More</code> section o' th' menu an' stored directly inside yer <code>rrrambl'n</code> directory t' now show up 'n th' menu aswell.</p>
|
||
<p>T' <a href="../cont/menushortcuts/index.html#shortcuts-to-pages-inside-of-your-project">get rid</a> o' this undesired behavior ye have two choices:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Make th' plank file a <a href="https://gohugo.io/content-management/page-bundles/#headless-bundle" target="_blank">headless branch bundle</a> (contained 'n its own subdirectory an' called <code>_index.md</code>) an' add th' follow'n frontmatter configurat'n t' th' file (see exampleSite’s <code>content/showcase/_index.en.md</code>). This causes its rrrambl'n t' <strong>not</strong> be ontained 'n th' sitemap.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Showcase"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s2">"always"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">list</span> <span class="p">=</span> <span class="s2">"never"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">publishResources</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p>Store th' plank file fer below a parent headless branch bundle an' add th' follow'n frontmatter t' he <strong>parent</strong> (see exampleSite’s <code>content/more/_index.en.md</code>).</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="c"># title = "More" ### ATTENTION: Don't give this plank a title as this will cause it t' be 'n th' breadcrumbs - a th'n ye most likely don't want</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s2">"never"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">list</span> <span class="p">=</span> <span class="s2">"never"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">publishResources</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div><p>In this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see exampleSite’s <code>content/more/credits.en.md</code>). This causes its rrrambl'n t' be contained 'n th' sitemap.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Credits"</span></span></span></code></pre></div></li>
|
||
</ol>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' required folder name fer th' <a href="../shortcodes/attachments/index.html"><code>attachments</code> shortcode</a> was changed fer leaf bundles.</p>
|
||
<p>Previously, th' attachments fer leaf bundles 'n non-multilang setups were required t' be 'n a <code>files</code> subdirectory. For plank bundles an' leaf bundles 'n multilang setups they were always required t' be 'n a <code>_index.<LANGCODE>.files</code> or <code>index.<LANGCODE>.files</code> subdirectory accordingly.</p>
|
||
<p>This added unnessessary complexity. So attachments fer leaf bundles 'n non-multilang setups can now also reside 'n a <code>index.files</code> directory. Although th' old <code>files</code> directory be now deprecated, if both directories be present, only th' old <code>files</code> directory will be used fer compatiblity.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Absolute links prefixed wit' <code>http://</code> or <code>https://</code> be now opened 'n a separate browser tab.</p>
|
||
<p>Ye can revert back t' th' old behavior by defin'n <code>externalLinkTarget="_self"</code> 'n th' <code>params</code> section o' yer <code>config.toml</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme now supports <a href="https://gohugo.io/hugo-modules/" target="_blank">Hugo’s module system</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="580">5.8.0 (2022-12-08)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new <a href="../shortcodes/badge/index.html"><code>badge</code> shortcode</a> be now avail'ble t' add highly configur'ble markers t' yer rrrambl'n as ye can see it on this plank.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new <a href="../shortcodes/icon/index.html"><code>ay'con</code> shortcode</a> simplyfies th' usage o' ay'cons. This can even be combined wit' also new <code>badge</code> shortcode.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme now supports some o' GFM (GitHub Flavored Markdown) rules an' Cap'n Hugo Marrrkdown extensions, namely <a href="../cont/markdown/index.html#tasks">task lists</a>, <a href="../cont/markdown/index.html#defintions">defint'n lists</a> an' <a href="../cont/markdown/index.html#footnotes">footnotes</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> A new color <code>--ACCENT-color</code> was introduced which be used fer highlightn'n search results on th' plank. In case ye simply don’t care, ye don’t need t' change anyth'n 'n yer variant stylesheet as th' old <code>yellow</code> color be still used as default.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="570">5.7.0 (2022-11-29)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' Korean language translat'n fer this theme be now avail'ble wit' th' language code <code>ko</code>. Formerly th' country code <code>kr</code> was used instead.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../shortcodes/button/index.html"><code>button</code> shortcode</a> can now also be used as a real button inside o' HTML forms - although this be a pretty rare use case. Th' documentat'n was updated accordingly.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' search now supports th' Korean language.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="560">5.6.0 (2022-11-18)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release introduces an additional dedicated search plank. On this plank, displayed search results have more space mak'n it easier scann'n thru large number o' results.</p>
|
||
<p>T' activate this feature, ye need t' <a href="../basics/configuration/index.html#activate-dedicated-search-page">configure it</a> 'n yer <code>config.toml</code> as a new outputformat <code>SEARCHPAGE</code> fer th' home plank. If ye don’t configure it, no dedicated search plank will be access'ble an' th' theme works as before.</p>
|
||
<p>Ye can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Keyboard handl'n fer th' TOC an' search was improved.</p>
|
||
<p>Press'n <code>CTRL+ALT+t</code> now will not only toggle th' TOC overlay but also places th' focus t' th' first head'n on open'n. Subsequently this makes it poss'ble t' easily select head'ns by us'n th' <code>TAB</code> key.</p>
|
||
<p>Th' search received its own brand new keyboard shortcut <code>CTRL+ALT+f</code>. This will focus th' cursor inside o' th' the search box so ye can immediately start yer search by typ'n.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Ye be now able t' turn off th' generat'n o' generator meta tags 'n yer HTML head t' hide th' used versions o' Cap'n Hugo an' this theme.</p>
|
||
<p>T' <a href="../basics/configuration/index.html#global-site-parameters">configure this</a> 'n yer <code>config.toml</code> make sure t' set Hugo’s <code>disableHugoGeneratorInject=true</code> <strong>an'</strong> also <code>[params] disableGeneratorVersion=true</code>, otherwise Cap'n Hugo will generate a meta tag into yer home plank automagically.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Creat'n o' yer project gets a little bit faster wit' this release.</p>
|
||
<p>This addresses increased build time wit' th' 5.x releases. Th' theme now heavily caches partial results lead'n t' improved performance. T' further increase performance, unnecessary parts o' th' plank be now skipped fer creat'n o' th' print output (eg. menus, navigat'n bar, etc.).</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="550">5.5.0 (2022-11-06)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' way images be processed has changed. Now images be lazy boarded by default which speeds up plank board on slow networks and/or big planks an' also th' print preview.</p>
|
||
<p>For that th' JavaScript code t' handle th' <a href="../cont/markdown/index.html#image-effects">lightbox an' image effects</a> on th' client side was removed 'n favour fer static generat'n o' those effects on th' server.</p>
|
||
<p>If ye have used HTML directly 'n yer Marrrkdown files, this now has th' downside that it doesn’t respect th' effect query parameter anymore. In this case ye have t' migrate all yer HTML <code>img</code> URLs manually t' th' respective HTML attributes.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Old</th>
|
||
<th>New</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code><img src="pic.png?width=20vw&classes=shadow,border"></code></td>
|
||
<td><code><img src="pic.png" style="width:20vw;" class="shadow border"></code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="540">5.4.0 (2022-11-01)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> <a href="../basics/configuration/index.html#serving-your-page-from-the-filesystem">Wit' th' proper sett'ns</a> 'n yer <code>config.toml</code> yer plank be now serv'ble from th' local file system us'n <code>file://</code> URLs.</p>
|
||
<p>Please note that th' searchbox will only work fer this if ye reconfigure yer outputformat fer th' homepage 'n yer <code>config.toml</code> from <code>JSON</code> t' <code>SEARCH</code>. Th' now deprecated <code>JSON</code> outputformat still works as before, so there be no need t' reconfigure yer installat'n if it be only served from <code>http://</code> or <code>https://</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' <a href="../shortcodes/button/index.html"><code>button</code> shortcode</a> has a new parameter <code>target</code> t' set th' destinat'n frame/window fer th' URL t' open. If not given, it defaults t' a new window/tab fer external URLs or be not set at all fer internal URLs. Previously even internal URLs whar' opened 'n a new window/tab.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../shortcodes/math/index.html"><code>math</code> shortcode</a> an' <a href="../shortcodes/mermaid/index.html"><code>mermaid</code> shortcode</a> now also support th' <code>align</code> parameter if codefence rules be used.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Support fer languages that be written right t' left (like Arabic). This be only implemented fer th' rrrambl'n area but not th' navigat'n sidebar. This feature be not avail'ble 'n Internet Explorer 11.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translat'n into Finnish (Suomi).</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="530">5.3.0 (2022-10-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Th' functionality o' th' new implementat'n does not work wit' old browsers (Internet Explorer 11).</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="../cont/markdown/index.html#add-css-classes">Image formatt'n</a> has two new classes t' align images t' th' <code>left</code> or <code>right</code>. Additionally, th' already exist'n <code>inline</code> opt'n be now documented.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Print'n fer th' <a href="../shortcodes/openapi/index.html"><code>swagger</code> shortcode</a> was optimized t' expand sections that be usually closed 'n interactive mode. This requires <a href="../basics/configuration/index.html#activate-print-support">print support</a> t' be configured.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="520">5.2.0 (2022-08-03)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> If you’ve set <code>collapsibleMenu = true</code> 'n yer <code>config.toml</code>, th' menu will be expanded if a search term be found 'n a collapsed submenu. Th' menu will return t' its initial collapse state once th' search term does not match any submenus.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="510">5.1.0 (2022-07-15)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.95.0</span></span> This release requires a newer Cap'n Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a <code>index.print.html</code> t' th' default URL.</p>
|
||
<p>Ye can revert this behavior by overwrit'n th' PRINT output format sett'n 'n yer <code>config.toml</code>t':</p>
|
||
<div class="wrap-code 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">outputFormats</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">outputFormats</span><span class="p">.</span><span class="nx">PRINT</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">"PRINT"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">baseName</span> <span class="p">=</span> <span class="s2">"index"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">path</span> <span class="p">=</span> <span class="s2">"_print"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">isHTML</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mediaType</span> <span class="p">=</span> <span class="s1">'text/html'</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">permalink'ble</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="500">5.0.0 (2022-07-05)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case you’ve added own JavaScript code that depends on th' themes jQuery implementat'n, ye have t' put it into a separate <code>*.js</code> file (if not already) an' add th' <code>defer</code> keyword t' th' <code>script</code> element. Eg.</p>
|
||
<div class="wrap-code 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">script</span> <span class="na">defer</span> <span class="na">src</span><span class="o">=</span><span class="s">"myscript.js"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' way <a href="../cont/archetypes/index.html">archetypes</a> be used t' generate output has changed. Th' new systems allows ye, t' redefine exist'n archetypes or even generate yer own ones.</p>
|
||
<p>Yer exist'n markdown files will still work like before an' therefore ye don’t need t' change anyth'n after th' upgrade. Nevertheless, it be recommended t' adapt yer exist'n markdown files t' th' new way as follows:</p>
|
||
<ul>
|
||
<li>
|
||
<p>fer yer home plank, add th' frontmatter parameter <code>archetype = "home"</code> an' remove th' lead'n head'n</p>
|
||
</li>
|
||
<li>
|
||
<p>fer all files contain'n th' deprecated frontmatter parameter <code>chapter = true</code>, replace it wit' <code>archetype = "chapter"</code> an' remove th' lead'n head'ns</p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' frontmatter opt'ns <code>pre</code> / <code>post</code> were renamed t' <code>menuPre</code> / <code>menuPost</code>. Th' old opt'ns will still be used if th' new opt'ns aren’t set. Therefore ye don’t need t' change anyth'n after th' upgrade.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Add'n new partials <code>heading-pre.html</code> / <code>heading-post.html</code> an' accord'n frontmatter opt'ns <code>headingPre</code> / <code>headingPost</code> t' modify th' way yer page`s main head'n gets styled.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new shortcode <code>math</code> be avail'ble t' add beautiful math an' chemical formulae. See th' <a href="../shortcodes/math/index.html">documentat'n</a> fer avail'ble features. This feature will not work wit' Internet Explorer 11.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="420">4.2.0 (2022-06-23)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> Th' second parameter fer th' <a href="../shortcodes/include/index.html"><code>include</code> shortcode</a> was switched 'n mean'n an' was renamed from <code>showfirsthead'n</code> t' <code>hidefirsthead'n</code>. If ye haven’t used this parameter 'n yer shortcode, th' default behavior hasn’t changed an' ye don’t need t' change anyth'n.</p>
|
||
<p>If you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Previously, if th' <a href="../shortcodes/tabs/index.html"><code>tabs</code> shortcode</a> could not find a tab item because, th' tabs ended up empty. Now th' first tab be selected instead.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' <code>landingPageURL</code> was removed from <code>config.toml</code>. Ye can safely remove this as well from yer configurat'n as it be not used anymore. Th' theme will detect th' land'n plank URL automatically an' will point t' th' project’s homepage. If ye want t' support a different link, overwrite th' <code>logo.html</code> partial.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shortcode.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="410">4.1.0 (2022-06-12)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> While fix'n issues wit' th' search functionality fer non Latin languages, ye can now <a href="../cont/i18n/index.html#search-with-mixed-language-support">configure t' have multiple languages on a single plank</a>.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="400">4.0.0 (2022-06-05)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> Th' <code>custom_css</code> config parameter was removed from th' configurat'n. If used 'n an exist'n installat'n, it can be achieved by overrid'n th' <code>custom-header.html</code> template 'n a much more generic manner.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> Because anchor hover color was not configur'ble without introduc'n more complexity t' th' variant stylesheets, we decided t' remove <code>--MAIN-ANCHOR-color</code> instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' anchors now get their colors from <code>--MAIN-LINK-color</code> an' <code>--MAIN-ANCHOR-HOVER-color</code> respectively.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’t need t' change anyth'n 'n yer installat'n.</p>
|
||
<p>This applies t' <a href="../shortcodes/expand/index.html"><code>expand</code></a>, <a href="../shortcodes/include/index.html"><code>include</code></a>, <a href="../shortcodes/notice/index.html"><code>notice</code></a> an' <a href="../shortcodes/siteparam/index.html"><code>siteparam</code></a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../shortcodes/button/index.html"><code>button</code></a> shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New colors <code>--PRIMARY-color</code> an' <code>--SECONDARY-color</code> were added t' provide easier modificat'n o' yer custom style. Shorrrtcodes wit' a color style can now have <code>primary</code> or <code>secondary</code> as additional values.</p>
|
||
<p>These two colors be th' default fer other, more specific color variables. Ye don’t need t' change anyth'n 'n yer exist'n custom color stylesheets as those variables get reason'ble default values.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translat'n into Polish. This language be not supported fer search.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' documentat'n fer all shorrrtcodes were revised.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="340">3.4.0 (2022-04-03)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> 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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Ye can activate <a href="../basics/configuration/index.html#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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translat'n into Traditional Chinese.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="330">3.3.0 (2022-03-28)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishes 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="../basics/generator/index.html">theme variant generator</a> o' th' exampleSite fer all avail'ble variables.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new shortcode <code>swagger</code> be avail'ble t' include a UI fer REST OpenAPI specificat'ns. See th' <a href="../shortcodes/openapi/index.html">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 (2022-03-19)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.93.0</span></span> This release requires a newer Cap'n Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shortcode or be us'n Merrrmaid codefences. This changes th' behavior o' <code>disableMermaid</code> config opt'n as follows: If a Merrrmaid shortcode 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 shortcode 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="../basics/generator/index.html">theme variant generator</a> o' th' exampleSite fer an example.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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 (2022-03-15)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="../shortcodes/attachments/index.html"><code>attachment</code></a> an' <a href="../shortcodes/notice/index.html"><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" target="_blank">Font Awesome 5 Free</a> ay'cons.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="300">3.0.0 (2022-02-22)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> We made changes t' th' menu footer. If ye have yer <code>menu-footer.html</code> <a href="../basics/customization/index.html">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 after th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' <em>Clear history</em> functionality).</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> 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="../basics/customization/index.html#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><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Due t' a bug, that we couldn’t fix 'n a general manner fer color variants, we decided t' remove <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><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> 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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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="../basics/customization/index.html#theme-variant">yer color variants</a>. Yer old variants will still work an' don’t need t' be changed as appropriate 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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive <a href="../basics/generator/index.html">theme variant generator</a>. This feature will not work wit' Internet Explorer 11.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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="../basics/customization/index.html#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 (2021-11-19)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> 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 compliant an' exchang'n this theme 'n yer project t' some other theme will be effortless.</p>
|
||
<p>In a standard compliant 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" target="_blank">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" target="_blank">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 compliant an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started <code>hugo server</code> after an upgrade an' no errors be written t' th' console.</p>
|
||
<p>Ye may see errors on th' console after th' update 'n th' form:</p>
|
||
<div class="wrap-code 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>Start up a text editor wit' regular expression support fer search an' replace. Search fer <code>(ref\s+"[^"]*?)(?:/_index|/index)?(?:\.md)?(#[^"]*?)?"</code> an' replace it by <code>$1$2"</code> 'n all <code>*.md</code> files. <strong>This be th' recommended choice</strong>.</p>
|
||
</li>
|
||
<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>
|
||
</ol>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="280">2.8.0 (2021-11-03)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> 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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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="../basics/customization/index.html#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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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="../basics/configuration/index.html#global-site-parameters">th' example configurat'n</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="270">2.7.0 (2021-10-24)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Optional second parameter fer <a href="../shortcodes/notice/index.html"><code>notice</code></a> shortcode t' set title 'n box header.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="260">2.6.0 (2021-10-21)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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="../basics/configuration/index.html#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 (2021-10-08)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> New colors <code>--CODE-BLOCK-color</code> an' <code>--CODE-BLOCK-BG-color</code> were added t' provide a fallback fer Hugos rules highlight'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 (2021-10-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> 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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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="../cont/pages/index.html#override-expand-state-rules-for-menu-entries">documentat'n</a> fer poss'ble values an' default behavior.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New frontmatter <code>ordersectionsby</code> opt'n t' change immediate children sort'n 'n menu an' <code>children</code> shortcode. Poss'ble values be <code>title</code> or <code>weight</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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" target="_blank">Cap'n Hugo documentat'n</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="230">2.3.0 (2021-09-13)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.81.0</span></span> This release requires a newer Cap'n Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Showcase multilanguage features by provid'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.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="220">2.2.0 (2021-09-09)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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 (2021-09-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.69.0</span></span> This release requires a newer Cap'n Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In case th' site’s structure contains additional *.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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> 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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> If a search term be found 'n an <code>expand</code> shortcode, th' expand will be opened.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' menu will scroll th' active item into view on board.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="200">2.0.0 (2021-08-28)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Rules highlight'n was switched t' th' <a href="https://gohugo.io/content-management/syntax-highlighting/" target="_blank">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><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> 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><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> <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><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Arrow navigat'n an' <code>children</code> shortcode 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><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> A plank without a <code>title</code> will be treated as <code>hidden=true</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further <a href="../cont/pages/index.html#override-expand-state-rules-for-menu-entries">documentat'n</a> fer poss'ble values an' default behavior.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See <a href="../basics/customization/index.html">documentat'n</a> fer further read'n.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Shortcode <a href="../shortcodes/children/index.html"><code>children</code></a> wit' new parameter <code>containerstyle</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New shortcode <a href="../shortcodes/include/index.html"><code>include</code></a> t' include arbitrary file rrrambl'n into a plank.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="120">1.2.0 (2021-07-26)</h2>
|
||
<ul>
|
||
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Shortcode <a href="../shortcodes/expand/index.html"><code>expand</code></a> wit' new parameter t' open on plank board.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="110">1.1.0 (2021-07-02)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> <a href="../shortcodes/mermaid/index.html">Merrrmaid</a> diagrams can now be panned an' zoomed. This isn’t configur'ble yet.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="../shortcodes/mermaid/index.html#configuration"><code>Merrrmaid</code></a> config opt'ns can be set 'n <code>config.toml</code>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="100">1.0.0 (2021-07-01)</h2>
|
||
<ul>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.65.0</span></span> Th' requirement fer th' Cap'n Hugo version o' this theme be th' same as fer th' Learrrn theme version 2.5.0 on 2021-07-01.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Initial fork o' th' <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">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" target="_blank">this comment</a> 'n th' Learrrn issues.</p>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="requirrrements">Requirrrements</h1>
|
||
|
||
|
||
<p>Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.</p>
|
||
<p>Just download at least version <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.95.0</span></span> o' th' <a href="https://gohugo.io/getting-started/installing/" target="_blank">Cap'n Hugo binary</a> fer yer OS (Windows, Linux, Mac).</p>
|
||
<p><a href="#R-image-599ea8903110a36b8568bdf016877f78" class="lightbox-link"><img src="../basics/requirements/magic.gif" alt="Magic" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: auto;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-599ea8903110a36b8568bdf016877f78"><img src="../basics/requirements/magic.gif" alt="Magic" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
|
||
|
||
<footer class="footline">
|
||
<div class=" taxonomy-categories term-list cstyle " title="Categories" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<i class="fa-fw fas fa-layer-group"></i>
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/categories/basic/index.html">basic</a></li>
|
||
</ul>
|
||
</div>
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/documentatn/index.html">documentat'n</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="installatn">Installat'n</h1>
|
||
|
||
|
||
<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/" target="_blank">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="wrap-code highlight"><pre tabindex="0"><code>hugo new ship <new_project></code></pre></div><h2 id="install-the-theme">Install th' theme</h2>
|
||
<p>Install th' Relearrrn theme by follow'n <a href="https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme" target="_blank">this documentat'n</a> us'n Hugo’s module system.</p>
|
||
<p>This theme’s repository be: <a href="https://github.com/McShelby/hugo-theme-relearn.git" target="_blank">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" target="_blank">download th' theme as .zip</a> file an' extract it 'n th' <code>themes</code> directory</p>
|
||
<h3 id="from-git">From Git</h3>
|
||
<p>If ye install th' theme from yer git repository or GitHub, ye have several opt'ns.</p>
|
||
<p>If ye use th' <code>head</code> o' th' <code>main</code> branch, ye be us'n th' development version. Usually it be fully functional but can break from time t' time. We try t' fix newly introduced bugs 'n this version as soon as poss'ble.</p>
|
||
<p>Additionally ye can checkout one o' th' tagged versions. These tagged versions correspond t' an official <a href="https://github.com/McShelby/hugo-theme-relearn/releases" target="_blank">releases from th' GitHub repository</a>.</p>
|
||
<p>Besides th' usual version tags (eg <code>1.2.3</code>) there be also tags fer th' main version (eg. <code>1.2.x</code>), major version (eg. <code>1.x</code>) an' th' latest (just <code>x</code>) released version mak'n it easier fer ye t' pin th' theme t' a certain version.</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="wrap-code 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">"SEARCH"</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="wrap-code 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><a href="#R-image-945d690907e8ac6478c83584e0488528" class="lightbox-link"><img src="../basics/installation/chapter.png?width=60pc" alt="A Chapter" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 60pc;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-945d690907e8ac6478c83584e0488528"><img src="../basics/installation/chapter.png?width=60pc" alt="A Chapter" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></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="wrap-code 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="wrap-code 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="wrap-code 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="wrap-code 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 cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>This website can be automatically published an' hosted wit' <a href="https://www.netlify.com/" target="_blank">Netlify</a> (Read more about <a href="https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/" target="_blank">Automated HUGO deployments wit' Netlify</a>). Alternatively, ye can use <a href="https://gohugo.io/hosting-and-deployment/hosting-on-github/" target="_blank">GitHub planks</a>.</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/config/index.html">config</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="configurrratn">Configurrrat'n</h1>
|
||
|
||
|
||
<h2 id="global-site-parameters">Global ship parameters</h2>
|
||
<p>On top o' <a href="https://gohugo.io/overview/configuration/" target="_blank">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="tab-panel" data-tab-group="9d29fa9bd86c43cf9aa199c5e93e32a7">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="configtoml"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('9d29fa9bd86c43cf9aa199c5e93e32a7','configtoml')"
|
||
>
|
||
<span class="tab-nav-text">config.toml</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="configtoml"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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"># If an opt'n value be said t' be not set, ye can achieve th' same behavior</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># by given it an empty str'n value.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">###############################################################################</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Cap'n Hugo</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns usually apply t' other themes aswell.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' author o' yer ship.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This will be used 'n HTML meta tags, th' opengraph protocol an' twitter</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># cards.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Ye can also set `author.email` if ye want t' publish this informat'n.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">author</span><span class="p">.</span><span class="nx">name</span> <span class="p">=</span> <span class="s2">"Sören Weber"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' social media image o' yer ship.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This be used fer generat'n social media meta informat'n fer th' opengraph</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># protocol an' twitter cards.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">images</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"images/hero.png"</span> <span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' descript'n o' yer ship.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This be used fer generat'n HTML meta tags, social media meta informat'n</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># fer th' opengraph protocol an' twitter cards.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">descript'n</span> <span class="p">=</span> <span class="s2">"Documentat'n fer Cap'n Hugo Relearrrn Theme"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Admin opt'ns fer social media.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Configurat'n fer th' Open Graph protocol an' Twitter Cards adhere t' Hugo's</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># implementat'n. See th' Cap'n Hugo docs fer poss'ble values.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">social</span><span class="p">.</span><span class="nx">facebook_admin</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">social</span><span class="p">.</span><span class="nx">twitter</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">###############################################################################</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Relearrrn Theme</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns be specific t' th' Relearrrn theme.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Variants</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns set yer color variant.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Used color variants.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: "auto"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This sets one or more color variants, avail'ble t' yer readers t' choose</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># from. Ye can either set a single value eg. "zen-light" or an array like</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># [ "neon", "learn" ]. If th' array has more than one entry, a variant selector</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be shown 'n th' lower part o' th' menu. Th' first entry 'n th' array be th'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># default variant, used fer first time visitors.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' theme ships wit' th' follow'n variants: "auto", "relearn-bright",</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># "relearn-light", "relearn-dark", "zen-light", "zen-dark", "neon", "learn",</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># "blue", "green", "red". Th' auto variant be somewhat special. See th'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># opt'n fer themeVariantAuto below.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Ye can also define yer own variants. See th' docs how this works. Also,</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># th' docs provide an interactive theme generator t' help ye wit' this task.</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">"auto"</span><span class="p">,</span> <span class="s2">"relearn-bright"</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 class="s2">"zen-light"</span><span class="p">,</span> <span class="s2">"zen-dark"</span><span class="p">,</span> <span class="s2">"neon"</span><span class="p">,</span> <span class="s2">"learn"</span><span class="p">,</span> <span class="s2">"blue"</span><span class="p">,</span> <span class="s2">"green"</span><span class="p">,</span> <span class="s2">"red"</span> <span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' color variants used fer auto mode.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: [ "relearn-light", "relearn-dark" ], overwritten by th' first</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># two non-auto opt'ns from themeVariant if existant.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' auto variant defines how yer ship adjusts t' yer selected OS sett'ns</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># fer light/dark mode. Th' first array element be th' variant fer light mode,</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># th' second fer dark mode.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">themeVariantAuto</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><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># General</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns be defin'n general, non visual behavior.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Avoid new asset URLs on build.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># By default JavaScript-files an' CSS-files get a unique ID on each rebuild.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This makes sure, th' user always has th' latest version an' not some stale</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># copy o' his browser cache. Anyways, it can be desire'ble t' turn this</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># off 'n certain circumstances. For example if ye have Hugo's dev server</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># runn'n. Also some proxies dislike this optimizat'n.</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></span><span class="line"><span class="cl"><span class="c"># Avoid generator meta tags.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Set this t' true if ye want t' dis'ble generat'n fer generator meta tags</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># o' Cap'n Hugo an' th' theme 'n yer HTML head. In tihs case also don't forget t'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># set Hugo's disableHugoGeneratorInject=true. Otherwise Cap'n Hugo will generate a</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># meta tag into yer home plank anyways.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableGeneratorVersion</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"># Avoid unique IDs.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># In various situat'ns th' theme generates non st'ble unique ids t' be used</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># 'n HTML fragment links. This can be undesir'ble fer example when test'n</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># th' output fer changes. If ye dis'ble th' random id generat'n, th' theme</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># may not funct'n correctly anymore.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableRandomIds</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"># Multilanguage rrrambl'n.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If yer planks contain further languages besides th' main one used, add all</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># those auxiliary languages here. This will create a search index wit'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># support fer all used languages o' yer ship.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This be handy fer example if ye be writ'n 'n Spanish but have lots o'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># source code on yer plank which typically uses English terminology.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">additionalContentLanguage</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"en"</span> <span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Additional code dependencies.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: See config.toml o' th' theme</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' theme provides a mechanism t' board further JavaScript an' CSS</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># dependencies on demand only if they be needed. This comes 'n handy if ye</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># want t' add own shorrrtcodes that depend on additional code t' be boarded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># See te docs how tihs works.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># [relearn.dependencies]</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Topbar</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns modify th' topbar appearance.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide th' t'ble o' contents button.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If th' TOC button be hidden, also th' keyboard shortcut be disabled.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</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></span><span class="line"><span class="cl"><span class="c"># Hide th' breadcrumbs.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># shown 'n th' topbar.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableBreadcrumb</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"># Hide Next an' Previous navigat'n buttons.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If th' navigat'n buttons be hidden, also th' keyboard shortcuts be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># disabled.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableNextPrev</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"># Th' URL prefix t' edit a plank.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set, an edit button will be shown 'n th' topbar. If th' button be hidden,</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># also th' keyboard shortcuts be disabled. Th' given URL be prepended t' th'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># relative file path o' a th' displayed plank. Th' URL must end wit' a `/`.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This be useful if ye wnat t' give th' opportunity fer people t' create merge</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># request fer yer rrrambl'n.</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><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Menu</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns modify th' menu apperance.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide th' search box.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If th' searc box be sisabled, th' search functionality be disabled too.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This will also cause th' keyboard shortcut t' be disabled an' th' dedicated</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># search plank be not linked although it mighty be configured.</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></span><span class="line"><span class="cl"><span class="c"># Hide th' Home entry.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If shown, a Home button will appear below th' search bar an' th' main menu.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># It links t' yer th' home plank o' th' current language.</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></span><span class="line"><span class="cl"><span class="c"># Th' order o' main menu submenus.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: "weight"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Submenus can be ordered by "weight", "title", "linktitle", "modifieddate",</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># "expirydate", "publishdate", "date", "length" or "default" (adher'n t'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hugo's default sort order). 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></span><span class="line"><span class="cl"><span class="c"># Th' initial expand state o' submenus.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This controls whether submenus will be expanded (true), or collapsed (false)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># 'n th' menu. If not set, th' first menu level be set t' false, all others</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># levels be set t' true. This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If th' displayed plank has submenus, they will always been displayed expanded</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># regardless o' this opt'n.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">alwaysopen</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Shows expander fer submenus.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># tree view an' a click'ble expander be set 'n front o' th' entry.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">collapsibleMenu</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Shows checkmarks fer visited planks o' th' main menu.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This also causes th' display o' th' `Clear History` entry 'n th' lower part</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># o' th' menu t' remove all checkmarks. Th' checkmarks will also been removed</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># if ye regenerate yer ship as th' ids be not st'ble.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">showVisitedLinks</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide head'n above th' shortcut menu.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' title fer th' head'n can be overwritten 'n yer i18n files. See Hugo's</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># documentat'n how t' do this.</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></span><span class="line"><span class="cl"><span class="c"># Hide th' language switcher.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If ye have more than one language configured, a language switcher be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># displayed 'n th' lower part o' th' menu. This opit'n lets ye explicitly</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># turn this behavior off.</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></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hidden planks</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how hidden planks be treated.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># A plank flagged as hidden, be only removed from th' main menu but behaves</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># like any other plank fer all other functionality 'n Hugo.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide hidden planks from search.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hides hidden planks from th' suggest'ns o' th' search box an' th' dedicated</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># search plank.</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></span><span class="line"><span class="cl"><span class="c"># Hide hidden planks fer web crawlers.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Avoids hidden planks from show'n up 'n th' sitemap an' on Google (et all),</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># 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">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide hidden planks fer taxonomies.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hides hidden planks from show'n up on th' taxonomy an' terms planks. If this</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># reduces term counters t' zero, an empty but not linked term plank will be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># created anyhow.</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></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Rrrambl'n</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns modify how yer rrrambl'n be displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Title separator.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: "::"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Changes th' title separator used when concatenat'n th' plank title wit' th'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># ship title. This be consistently used throughout th' theme.</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></span><span class="line"><span class="cl"><span class="c"># Breadcrumb separator.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: ">"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Changes th' breadcrumb separator used 'n th' topbars breadcrumb area an' fer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># search results an' term planks.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">breadcrumbSeparator</span> <span class="p">=</span> <span class="s2">">"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide th' root breadcrumb.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' root breadcrumb be usually th' home plank o' yer ship. Because this be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># always access'ble by click'n on th' logo, ye may want t' reduce clutter</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># by remov'n this from yer breadcrumb.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableRootBreadcrumb</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide breadcrumbs term planks.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If ye have lots o' taxonomy terms, th' term planks may seem cluttered wit'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># breadcrumbs t' ye, so this be th' opt'n t' turn off breadcrumbs on term</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># planks. Only th' plank title will then be shown on th' term planks.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableTermBreadcrumbs</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">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Highlight</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how code be displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide copy-to-clipboard fer inline code.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This removes th' copy-to-clipboard button from yer inline code.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableInlineCopyToClipBoard</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Always show copy-to-clipboard fer block code.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' theme only shows th' copy-to-clipboard button if ye hover over th' code</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># block. Set this t' true t' dis'ble th' hover effect an' always show th'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># button.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableHoverBlockCopyToClipBoard</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"># Wrap fer code blocks.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># By default lines o' code blocks wrap around if th' line be too long t' be</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># displayed on screen. If ye dislike this behavior, ye can reconfigure it</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># here.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Avast that lines always wrap 'n print mode regardless o' this opt'n.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter or given as a parameter t'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># individual code blocks.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">highlightWrap</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Images</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how images be displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Image effects.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># See th' documentat'n fer how ye can even add yer own arbitrary effects t'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># th' list.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># All effects can be overridden 'n th' page's frontmatter or thru URL parameter</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># given t' th' image. See th' documentat'n fer details.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">imageEffects</span><span class="p">.</span><span class="nx">shadow</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">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Links</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how links be displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># How t' open external links.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: "_blank"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># For external links ye can define how they be opened 'n yer browser. All</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># values fer th' HTML `target` attribute o' th' `a` element be allowed. Th'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># default value opens external links 'n a separate browser tab. If ye want</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># t' open those links 'n th' same tab, use "_self".</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">externalLinkTarget</span> <span class="p">=</span> <span class="s2">"_blank"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Generate link URLs th' Cap'n Hugo way.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If set t' true, th' theme behaves like a standard Cap'n Hugo installat'n an'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># appends no index.html t' prettyURLs. As a trade off, yer build project will</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># not be serv'ble from th' file system.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableExplicitIndexURLs</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">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Merrrmaid</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how Merrrmaid graphs be displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Make graphs pan'ble an' zoom'ble</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: false</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># wit' a reset button fer th' zoom.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter or given as a parameter t'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># individual graphs.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Initializat'n opt'ns fer Merrrmaid.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s2">"{ \"securityLevel\": \"loose\" }"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Only board Merrrmaid if needed.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be us'n script'n t' set up yer graph. In this case no shortcode or</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># codefence be involved an' th' library be not boarded by default. In this case</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be boarded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableMermaid</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># URL fer external Merrrmaid library.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customMermaidURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/mermaid/dist/mermaid.min.js"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># MathJax</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how math formulae be displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Initializat'n opt'ns fer MathJax.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s2">"{}"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Only board MathJax if needed.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If a Math shortcode be found, th' opt'n will be ignored an'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be us'n script'n t' set up yer graph. In this case no shortcode or</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># codefence be involved an' th' library be not boarded by default. In this case</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be boarded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableMathJax</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># URL fer external MathJax library.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Specifies th' remote locat'n o' th' MathJax library. By default th' shipped</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customMathJaxURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c">#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># OpenApi</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># These opt'ns configure how OpenAPI specificat'ns be displayed.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Only board OpenAPI if needed.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># If a OpenAPI shortcode be found, th' opt'n will be ignored an'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be us'n script'n t' set up yer graph. In this case no shortcode or</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># codefence be involved an' th' library be not boarded by default. In this case</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t'</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># be boarded.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">disableOpenapi</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="c"># URL fer external OpenAPI library.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Default: not set</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># version will be used.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># This can be overridden 'n th' page's frontmatter.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">customOpenapiURL</span> <span class="p">=</span> <span class="s2">""</span> <span class="c"># "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><h2 id="serving-your-page-from-a-subfolder">Serv'n yer plank from a subfolder</h2>
|
||
<p>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="wrap-code 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><span class="line"><span class="cl"><span class="nx">relativeURLs</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" target="_blank">https://github.com/gohugoio/hugo/issues/5226</a>.</p>
|
||
<h2 id="serving-your-page-from-the-filesystem">Serv'n yer plank from th' filesystem</h2>
|
||
<p>If ye want yer plank served from th' filesystem by us'n URLs start'n wit' <code>file://</code> you’ll need th' follow'n configurat'n 'n yer <code>config.toml</code>:</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">relativeURLs</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div><p>Th' theme will append an additional <code>index.html</code> t' all branch bundle links by default t' make th' plank be serv'ble from th' file system. If ye don’t care about th' file system an' only serve yer plank via a webserver ye can also generate th' links without this change by add'n this t' yer <code>config.toml</code></p>
|
||
<div class="wrap-code 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">disableExplicitIndexURLs</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>If ye want t' use th' search feature from th' file system us'n an older installat'n o' th' theme make sure t' change yer outputformat fer th' homepage from th' now deprecated <code>JSON</code> t' <code>SEARCH</code> <a href="#activate-search">as seen below</a>.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="activate-search">Activate search</h2>
|
||
<p>If not already present, add th' follow'n lines 'n th' same <code>config.toml</code> file.</p>
|
||
<div class="wrap-code 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">"SEARCH"</span><span class="p">]</span></span></span></code></pre></div><p>This will generate a search index file at th' root o' yer public folder ready t' be consumed by th' Lunr search library. Avast that th' <code>SEARCH</code> outputformat was named <code>JSON</code> 'n previous releases but was implemented differently. Although <code>JSON</code> still works, it be now deprecated.</p>
|
||
<h3 id="activate-dedicated-search-page">Activate dedicated search plank</h3>
|
||
<p>Ye can add a dedicated search plank fer yer plank by add'n th' <code>SEARCHPAGE</code> outputformat t' yer home plank by add'n th' follow'n lines 'n yer <code>config.toml</code> file. This will cause Cap'n Hugo t' generate a new file <code>http://example.com/mysite/search.html</code>.</p>
|
||
<div class="wrap-code 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">"SEARCH"</span><span class="p">,</span> <span class="s2">"SEARCHPAGE"</span><span class="p">]</span></span></span></code></pre></div><p>Ye can access this plank by either click'n on th' magnifier glass or by typ'n some search term an' press'n <code>ENTER</code> inside o' th' menu’s search box .</p>
|
||
<p><a href="#R-image-b4098db5004f210349b9a4f465ac9440" class="lightbox-link"><img src="../basics/configuration/search_page.png?&width=60pc" alt="Screenshot o' th' dedicated search page" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 60pc;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-b4098db5004f210349b9a4f465ac9440"><img src="../basics/configuration/search_page.png?&width=60pc" alt="Screenshot o' th' dedicated search page" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>T' have Cap'n Hugo create th' dedicated search plank successfully, ye must not generate th' URL <code>http://example.com/mysite/search.html</code> from yer own rrrambl'n. This can happen if ye set <code>uglyURLs=true</code> 'n yer <code>config.toml</code> an' defin'n a Marrrkdown file <code>content/search.md</code>.</p>
|
||
<p>T' make sure, there be no duplicate rrrambl'n fer any given URL o' yer project, run <code>hugo --printPathWarn'ns</code>.</p>
|
||
</div>
|
||
</div>
|
||
<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="wrap-code 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">"SEARCH"</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 cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>Th' result'n URL will not be <a href="https://gohugo.io/templates/output-formats/#configure-output-formats" target="_blank">configured ugly</a> 'n terms o' <a href="https://gohugo.io/content-management/urls/#ugly-urls" target="_blank">Hugo’s URL handl'n</a> even if you’ve set <code>uglyURLs=true</code> 'n yer <code>config.toml</code>. This be due t' th' fact that fer one mime type only one suffix can be configured.</p>
|
||
<p>Nevertheless, if you’re unhappy wit' th' result'n URLs ye can manually redefine <code>outputFormats.PRINT</code> 'n yer own <code>config.toml</code> t' yer lik'n.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="mathjax">MathJax</h2>
|
||
<p>Th' MathJax 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="../shortcodes/math/index.html">Math</a> fer additional documentat'n.</p>
|
||
<h3 id="math-example">Example</h3>
|
||
<p>MathJax be globally disabled. By default it won’t be boarded by any plank.</p>
|
||
<p>On plank “Physics” ye coded some JavaScript fer a dynamic formulae. Ye can set th' MathJax parameters locally t' board mathJax on this plank.</p>
|
||
<p>Ye also can dis'ble MathJax fer specific planks while globally enabled.</p>
|
||
<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="../shortcodes/mermaid/index.html">Merrrmaid</a> fer additional documentat'n.</p>
|
||
<h3 id="mermaid-example">Example</h3>
|
||
<p>Merrrmaid be globally disabled. By default it won’t be boarded by any plank.</p>
|
||
<p>On plank “Architecture” ye coded some JavaScript t' dynamically generate a class diagram. Ye can set th' Merrrmaid parameters locally t' board mermaid on this plank.</p>
|
||
<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="wrap-code 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="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">params</span><span class="p">]</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="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">params</span><span class="p">]</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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><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><a href="#R-image-041a52883d8e9726ea3465077350abc0" class="lightbox-link"><img src="../basics/configuration/home_button_defaults.png?width=18.75rem" alt="Default Home Button" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 18.75rem;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-041a52883d8e9726ea3465077350abc0"><img src="../basics/configuration/home_button_defaults.png?width=18.75rem" alt="Default Home Button" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
<h2 id="social-media-meta-tags">Social Media Meta Tags</h2>
|
||
<p>Ye can add social media meta tags fer th' <a href="https://gohugo.io/templates/internal/#open-graph" target="_blank">Open Graph</a> protocol an' <a href="https://gohugo.io/templates/internal/#twitter-cards" target="_blank">Twitter Cards</a> t' yer ship. These be configured as mentioned 'n th' Cap'n Hugo docs.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="customizatn">Customizat'n</h1>
|
||
|
||
|
||
<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/" target="_blank">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/" target="_blank">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. See <a href="#output-formats">output-formats</a></li>
|
||
<li><code>footer.html</code>: th' footer o' th' plank. See <a href="#output-formats">output-formats</a></li>
|
||
<li><code>body.html</code>: th' body o' th' plank. Th' body may contain o' one or many articles. See <a href="#output-formats">output-formats</a></li>
|
||
<li><code>article.html</code>: th' output fer a single article, can contain elements around yer rrrambl'n. See <a href="#output-formats">output-formats</a></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 JavaScript. 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>heading-pre.html</code>: side-wide configurat'n t' prepend t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’s <code>headingPre</code> sett'n into account.</li>
|
||
<li><code>heading-post.html</code>: side-wide configurat'n t' append t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’s <code>headingPost</code> sett'n into account.</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 responsibility t' take th' page’s <code>menuPre</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 responsibility t' take th' page’s <code>menuPost</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 want t' display page’s meta data above or below th' rrrambl'n.</li>
|
||
<li><code>content-header.html</code>: header above th' title, has a default implementat'n but ye can overwrite it if ye don’t like it.</li>
|
||
<li><code>content-footer.html</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 cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></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> respectively.</p>
|
||
<p>Additionally, if ye want yer ship t' use light & dark theme favicons that follow th' OS’ (and 'n some cases, th' browser’s) color scheme, add th' image files t' yer local <code>static/images/</code> folder an' name them eg. <code>favicon-light.svg</code> and/or <code>favicon-dark.svg</code> respectively correspond'n t' yer file format. In case one o' th' files be miss'n, th' theme falls back t' eg. <code>favicon.svg</code> fer th' miss'n file. All supplied favicons must be o' th' same file format.</p>
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Arrr</div>
|
||
<div class="box-content">
|
||
|
||
<p>IE an' old browser versions do not support <a href="https://caniuse.com/css-media-interaction" target="_blank">media queries</a>, which be necessary fer th' light & dark theme favicon opt'n.
|
||
If ye have requirements t' support IE and/or older browser versions, use one o' th' other opt'ns.</p>
|
||
</div>
|
||
</div>
|
||
<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="wrap-code 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="change-the-menu-width">Change th' Menu Width</h2>
|
||
<p>Th' menu width adjusts automatically fer different screen sizes.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Screen Width</th>
|
||
<th>Menu Width</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>S</td>
|
||
<td>< 48rem</td>
|
||
<td>0</td>
|
||
</tr>
|
||
<tr>
|
||
<td>M</td>
|
||
<td>48rem - 60rem</td>
|
||
<td>14.375rem</td>
|
||
</tr>
|
||
<tr>
|
||
<td>L</td>
|
||
<td>>= 60rem</td>
|
||
<td>18.75rem</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Th' values fer th' screen width breakpoints aren’t configur'ble.</p>
|
||
<p>If ye want t' adjust th' menu width ye can define th' follow'n CSS variables 'n yer <code>custom-header.html</code>. Avast that <code>--MENU-WIDTH-S</code> doesn’t exist as th' menu be always hidden fer small screen sizes.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="line"><span class="cl"><span class="p">:</span><span class="nd">root</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nv">--MENU-WIDTH-M</span><span class="p">:</span> <span class="mf">14.375</span><span class="kt">rem</span><span class="p">;</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nv">--MENU-WIDTH-L</span><span class="p">:</span> <span class="mf">18.75</span><span class="kt">rem</span><span class="p">;</span>
|
||
</span></span><span class="line"><span class="cl"><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="wrap-code 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 example 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 chosen on first view an' a variant switch will be shown 'n th' menu footer.</p>
|
||
<div class="wrap-code 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 cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Smarrrt Arrrse</div>
|
||
<div class="box-content">
|
||
|
||
<p>If ye want t' switch th' rules highlight'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/" target="_blank">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="adjust-to-os-settings">Adjust t' OS Sett'ns</h3>
|
||
<p>Ye can also cause th' ship t' adjust t' yer OS sett'ns fer light/dark mode. Just set th' <code>themeVariant</code> t' <code>auto</code>. That’s it.</p>
|
||
<p>If you’ve set multiple variants, ye can drop <code>auto</code> at any posit'n, but usually it makes sense t' set it 'n th' first posit'n an' make it th' default.</p>
|
||
<div class="wrap-code 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="p">[</span> <span class="s2">"auto"</span><span class="p">,</span> <span class="s2">"red"</span> <span class="p">]</span></span></span></code></pre></div><p>If ye don’t configure anyth'n else, th' theme will use <code>relearn-light</code> fer light mode an' <code>relearn-dark</code> fer dark mode.</p>
|
||
<p>If ye don’t like that, ye can set <code>themeVariantAuto</code>. Th' first element be th' variant fer light mode, th' second fer dark mode</p>
|
||
<div class="wrap-code 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">themeVariantAuto</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"learn"</span><span class="p">,</span> <span class="s2">"neon"</span> <span class="p">]</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>This be not supported fer Internet Explorer 11, which still displays 'n th' <code>relearn-light</code> variant.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="javascript">JavaScript</h3>
|
||
<p>Once a variant be fully boarded, either initially or by switch'n th' variant manually wit' th' variant selector, th' custom event <code>themeVariantLoaded</code> on th' <code>document</code> will be dispatched. Ye can add an event listener an' react t' changes.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="nb">document</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span> <span class="s1">'themeVariantLoaded'</span><span class="p">,</span> <span class="kd">funct'n</span><span class="p">(</span> <span class="nx">e</span> <span class="p">){</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span> <span class="nx">e</span><span class="p">.</span><span class="nx">detail</span><span class="p">.</span><span class="nx">variant</span> <span class="p">);</span> <span class="c1">// `relearn-light`
|
||
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="p">});</span></span></span></code></pre></div><h3 id="roll-your-own">Roll yer Own</h3>
|
||
<p>If ye be not happy wit' th' shipped variants ye can either copy an' rename one o' th' shipped files from <code>themes/hugo-theme-relearn/static/css</code> t' <code>static/css</code>, edit them afterwards t' yer lik'n 'n a text editor an' configure th' <code>themeVariant</code> parameter 'n yer <code>config.toml</code> or just use th' <a href="../basics/generator/index.html">interactive variant generator</a>.</p>
|
||
<h2 id="own-shortcodes-with-javascript-dependencies">Own Shorrrtcodes wit' JavaScript Dependencies</h2>
|
||
<p>Certain shorrrtcodes make use o' additional JavaScript files. Th' theme only loads these dependencies if th' shortcode be used. T' do so correctly th' theme adds management code 'n various files. T' provide this behavior t' th' user an' extend'n it fer his own shorrrtcodes this can be configured.</p>
|
||
<p>Say ye want t' add a shortcode <code>myshortcode</code> that also requires th' <code>jquery</code> JavaScript library.</p>
|
||
<ol>
|
||
<li>
|
||
<p>Write th' shortcode file <code>layouts/shortcodes/myshortcode.html</code> an' add th' follow'n line</p>
|
||
<div class="wrap-code 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="p">.</span><span class="nx">Store</span><span class="p">.</span><span class="nx">Set</span> <span class="s">"hasMyShortcode"</span> <span class="kc">true</span> <span class="p">}}</span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p>Add th' follow'n snippet t' yer <code>config.toml</code></p>
|
||
<div class="wrap-code 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">params</span><span class="p">.</span><span class="nx">relearn</span><span class="p">.</span><span class="nx">dependencies</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">relearn</span><span class="p">.</span><span class="nx">dependencies</span><span class="p">.</span><span class="nx">myshortcode</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">name</span> <span class="p">=</span> <span class="s">"MyShortcode"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">locat'n</span> <span class="p">=</span> <span class="s">"footer"</span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p>Add th' dependency loader file <code>layouts/partials/dependencies/myshortcode.html</code>. Th' loader file will be appended t' yer header or footer, dependend on th' <code>locat'n</code> sett'n 'n yer <code>config.toml</code>.</p>
|
||
<div class="wrap-code 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">script</span> <span class="na">src</span><span class="o">=</span><span class="s">"https://www.unpkg.com/jquery/dist/jquery.js"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span></span></span></code></pre></div></li>
|
||
</ol>
|
||
<p>Character cas'n be relevant!</p>
|
||
<ul>
|
||
<li>th' <code>name</code> sett'n 'n yer <code>config.toml</code> must match th' key (that needs t' be prefixed wit' a <code>has</code>) ye used fer th' store 'n yer <code>layouts/shortcodes/myshortcode.html</code>.</li>
|
||
<li>th' key on <code>params.relearn.dependencies</code> 'n yer <code>config.toml</code> must match th' base file name o' yer loader file.</li>
|
||
</ul>
|
||
<p>See th' <code>math</code>, <code>mermaid</code> an' <code>openapi</code> shorrrtcodes fer examples.</p>
|
||
<h2 id="output-formats">Output Formats</h2>
|
||
<p>Certain parts o' th' theme can be changed fer support o' yer own <a href="https://gohugo.io/templates/output-formats/" target="_blank">output formats</a>. Eg. if ye define a new output format <code>PLAINTEXT</code> 'n yer <code>config.toml</code>, ye can add a file <code>layouts/partials/header.plaintext.html</code> t' change th' way, th' plank header should look like fer that output format.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
<div class=" taxonomy-categories term-list cstyle " title="Categories" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<i class="fa-fw fas fa-layer-group"></i>
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/categories/custom/index.html">custom</a></li>
|
||
<li><a class="term-link" href="../pir/categories/theming/index.html">theming</a></li>
|
||
</ul>
|
||
</div>
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="stylesheet-generrratr">Stylesheet generrrat'r</h1>
|
||
|
||
|
||
<p>This interactive tool may help ye t' generate yer own color variant stylesheet.</p>
|
||
|
||
<div class="expand">
|
||
<input type="checkbox" id="R-expand-47fe2e1887da08654e2ec68c003d3b94" aria-controls="R-expandcontent-47fe2e1887da08654e2ec68c003d3b94" >
|
||
<label class="expand-label" for="R-expand-47fe2e1887da08654e2ec68c003d3b94" >
|
||
<i class="fas fa-chevron-down"></i>
|
||
<i class="fas fa-chevron-right"></i>
|
||
Show usage instruct'ns
|
||
</label>
|
||
<div id="R-expandcontent-47fe2e1887da08654e2ec68c003d3b94" class="expand-content">
|
||
|
||
<p>T' get started, first select a color variant from th' variant switch 'n th' lower left sidebar 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 <strong>an' th' plank</strong> will update accordingly.</p>
|
||
<p>Th' arrowed lines reflect 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' different 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 <strong>browse t' other planks</strong> an' even close th' browser <strong>without los'n yer changes</strong>.</p>
|
||
<p>Once ye be satisfied, ye can download th' new variants file an' copy it into yer site’s <code>static/css</code> directory. Afterwards ye have t' adjust th' <code>themeVariant</code> parameter 'n yer <code>config.toml</code> t' yer chosen file name.</p>
|
||
<p>Eg. if yer new variants file be named <code>theme-my-custom-variant.css</code>, ye have t' set <code>themeVariant='my-custom-variant'</code> t' use it.</p>
|
||
</div>
|
||
</div>
|
||
<p>
|
||
<span class="btn cstyle secondary">
|
||
<button onclick="window.variants&&variants.getStylesheet();this.blur();" type="button">
|
||
<i class="fa-fw fas fa-download"></i>
|
||
Download variant
|
||
</button>
|
||
</span>
|
||
|
||
<span class="btn cstyle warning">
|
||
<button onclick="window.variants&&variants.resetVariant();this.blur();" type="button">
|
||
<i class="fa-fw fas fa-trash"></i>
|
||
Reset variant
|
||
</button>
|
||
</span></p>
|
||
<div id="R-vargenerator" class="mermaid zoom" style="background-color: var(--INTERNAL-MAIN-TEXT-color);">Graph</div>
|
||
<p>
|
||
<span class="btn cstyle secondary">
|
||
<button onclick="window.variants&&variants.getStylesheet();this.blur();" type="button">
|
||
<i class="fa-fw fas fa-download"></i>
|
||
Download variant
|
||
</button>
|
||
</span>
|
||
|
||
<span class="btn cstyle warning">
|
||
<button onclick="window.variants&&variants.resetVariant();this.blur();" type="button">
|
||
<i class="fa-fw fas fa-trash"></i>
|
||
Reset variant
|
||
</button>
|
||
</span></p>
|
||
<script>
|
||
window.variants && variants.generator( '#R-vargenerator' );
|
||
</script>
|
||
|
||
|
||
<footer class="footline">
|
||
<div class=" taxonomy-categories term-list cstyle " title="Categories" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<i class="fa-fw fas fa-layer-group"></i>
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/categories/theming/index.html">theming</a></li>
|
||
</ul>
|
||
</div>
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="topbarrr-modificatn">Topbarrr Modificat'n</h1>
|
||
|
||
|
||
<p>Th' theme comes wit' a reasonably configured topbar.</p>
|
||
<p><a href="#R-image-f0bd75baeb38696591a6305bb284dc8a" class="lightbox-link"><img src="../basics/topbar/topbar-closed.png" alt="Topbar on mobile devices" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: auto;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-f0bd75baeb38696591a6305bb284dc8a"><img src="../basics/topbar/topbar-closed.png" alt="Topbar on mobile devices" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
<p>Nevertheless, yer requirements may differ from this configurat'n. Luckily th' theme got ye covered as th' themebar, its buttons an' th' functionality behind these buttons be fully configur'ble by ye.</p>
|
||
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Smarrrt Arrrse</div>
|
||
<div class="box-content">
|
||
|
||
<p>All mentioned file names below can be clicked an' show ye th' implementat'n fer a better understand'n.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="areas">Areas</h2>
|
||
<p>Th' default configurat'n comes wit' three predefined areas that may contain an arbitrary set o' buttons.</p>
|
||
<p><a href="#R-image-8fde7e05ee0711eb2ffd4ed3a5dd6364" class="lightbox-link"><img src="../basics/topbar/topbar-areas.png" alt="Topbar wit' default areas marked" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: auto;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-8fde7e05ee0711eb2ffd4ed3a5dd6364"><img src="../basics/topbar/topbar-areas.png" alt="Topbar wit' default areas marked" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
<ul>
|
||
<li><a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/start.html" target="_blank"><strong>start</strong></a>: shown between menu an' breadcrumb</li>
|
||
<li><a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/end.html" target="_blank"><strong>end</strong></a>: shown on th' opposite breadcrumb side 'n comparison t' th' <em>start</em> area</li>
|
||
<li><a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/more.html" target="_blank"><strong>more</strong></a>: shown when press'n th'
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-ellipsis-v"></i>
|
||
|
||
</button>
|
||
</span> <em>more</em> button 'n th' topbar</li>
|
||
</ul>
|
||
<p>While ye can not add additional areas 'n th' topbar, ye be free t' configure addtional buttons that behave like th' <em>more</em> button, provid'n further user defined areas.</p>
|
||
<h2 id="buttons">Buttons</h2>
|
||
<p>Th' theme ships wit' th' follow'n predefined buttons (from left t' right 'n th' screenshot)</p>
|
||
<ul>
|
||
<li>
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-bars"></i>
|
||
|
||
</button>
|
||
</span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/sidebar.html" target="_blank"><strong>sidebar</strong></a>: opens th' sidebar flyout if 'n mobile layout</li>
|
||
<li>
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-list-alt"></i>
|
||
|
||
</button>
|
||
</span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/toc.html" target="_blank"><strong>toc</strong></a>: opens th' t'ble o' contents 'n an overlay</li>
|
||
<li>
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-pen"></i>
|
||
|
||
</button>
|
||
</span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/edit.html" target="_blank"><strong>edit</strong></a>: browses t' th' edit'ble plank if th' <code>editURL</code> <a href="../basics/configuration/index.html#global-site-parameters">parameter be set</a></li>
|
||
<li>
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-print"></i>
|
||
|
||
</button>
|
||
</span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html" target="_blank"><strong>print</strong></a>: browses t' th' chapters print'ble plank if <a href="../basics/configuration/index.html#activate-print-support">print support</a> was activated</li>
|
||
<li>
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-chevron-left"></i>
|
||
|
||
</button>
|
||
</span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/prev.html" target="_blank"><strong>prev</strong></a>: browses t' th' previous plank if there be one</li>
|
||
<li>
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-chevron-right"></i>
|
||
|
||
</button>
|
||
</span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/next.html" target="_blank"><strong>next</strong></a>: browses t' th' next plank if there be one</li>
|
||
<li>
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-ellipsis-v"></i>
|
||
|
||
</button>
|
||
</span> <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/more.html" target="_blank"><strong>more</strong></a>: opens th' overlay fer th' <em>more</em> area</li>
|
||
</ul>
|
||
<p>Not all buttons be displayed at every given time. This be configur'ble (see below if interested).</p>
|
||
<h2 id="redefining-areas">Redefin'n Areas</h2>
|
||
<p>Each predefined area an' button comes 'n their own file. By that it be easy fer ye t' overwrite an area file 'n yer installat'n reus'n only th' buttons ye like.</p>
|
||
<p>Eg. ye can redefine th' predefined <em>end</em> area by add'n th' file <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/end.html" target="_blank"><code>layouts/partials/topbar/area/end.html</code></a> 'n yer installat'n (not 'n th' theme itself) t' remove all but th' <em>more</em> button.</p>
|
||
<p>Th' below example sets an explicit value fer th' <code>onempty</code> parameter, overrid'n th' specific default value fer this button (these defaults vary depend'n on th' button). Th' parameter causes th' <em>more</em> button t' always be displayed instead o' hid'n once its rrrambl'n be empty.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"topbar/button/more.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"onempty"</span> <span class="s">"disable"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div><h2 id="defining-own-buttons">Defin'n own Buttons</h2>
|
||
<h3 id="button-types">Button Types</h3>
|
||
<p>Th' theme distingushies between two types o' buttons:</p>
|
||
<ul>
|
||
<li><a href="#button"><strong>button</strong></a>: a click'ble button that either browses t' another ship, triggers a user defined script or opens an overlay contain'n user defined rrrambl'n</li>
|
||
<li><a href="#area-button"><strong>area-button</strong></a>: th' template fer th'
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-ellipsis-v"></i>
|
||
|
||
</button>
|
||
</span> <em>more</em> button, t' define yer own area overlay buttons</li>
|
||
</ul>
|
||
<h3 id="button-parameter">Button Parameter</h3>
|
||
<h4 id="screen-widths-and-actions">Screen Widths an' Act'ns</h4>
|
||
<p>Depend'n on th' screen width ye can configure how th' button should behave. Screen width be divided into three classes:</p>
|
||
<ul>
|
||
<li><strong>s</strong>: (controlled by th' <code>onwidths</code> parameter) mobile layout whar' th' menu sidebar be hidden</li>
|
||
<li><strong>m</strong>: (controlled by th' <code>onwidthm</code> parameter) desktop layout wit' vis'ble sidebar while th' rrrambl'n area width still resizes</li>
|
||
<li><strong>l</strong>: (controlled by th' <code>onwidthl</code> parameter) desktop layout wit' vis'ble sidebar once th' rrrambl'n area reached its maximum width</li>
|
||
</ul>
|
||
<p>For each width class, ye can configure one o' th' follow'n act'ns:</p>
|
||
<ul>
|
||
<li><code>show</code>: th' button be displayed 'n its given area</li>
|
||
<li><code>hide</code>: th' button be removed</li>
|
||
<li><code>area-XXX</code>: th' button be moved from its given area into th' area <code>XXX</code>; eg. this be used t' move buttons t' th' <em>more</em> area overlay 'n th' mobile layout</li>
|
||
</ul>
|
||
<h4 id="hiding-and-disabling-stuff">Hid'n an' Disabl'n Stuff</h4>
|
||
<p>While hid'n a button dependend on th' screen size can be configured wit' th' above described <em>hide</em> act'n, ye may want t' hide th' button on certain other condit'ns aswell.</p>
|
||
<p>For example, th' <em>print</em> button 'n its default configurat'n should only be displayed if print support was configured. This be done 'n yer button template by check'n th' condit'ns first before display'n th' button (see <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html" target="_blank"><code>layouts/partials/topbar/button/print.html</code></a>).</p>
|
||
<p>Another prefered condit'n fer hid'n a button be, if th' displayed overlay be empty. This be th' case fer th' <em>toc</em> (see <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/toc.html" target="_blank"><code>layouts/partials/topbar/button/toc.html</code></a>) aswell as th' <em>more</em> button (see <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/more.html" target="_blank"><code>layouts/partials/topbar/button/more.html</code></a>) an' controlled by th' parameter <code>onempty</code>.</p>
|
||
<p>This parameter can have one o' th' follow'n values:</p>
|
||
<ul>
|
||
<li><code>dis'ble</code>: th' button displayed 'n disabled state if th' overlay be empty</li>
|
||
<li><code>hide</code>: th' button be removed if th' overlay be empty</li>
|
||
</ul>
|
||
<p>If ye want t' dis'ble a button contain'n <em>no overlay</em>, this can be achieved by an empty <code>href</code> parameter. An example can be seen 'n th' <em>prev</em> button (see <code>layouts/partials/topbar/button/prev.html</code>) whar' th' URL fer th' previous ship may be empty.</p>
|
||
<h2 id="reference">Reference</h2>
|
||
<h3 id="button">Button</h3>
|
||
<p>Contains th' basic button functionality an' be used as a base implementat'n fer all other buttons (<a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/func/button.html" target="_blank"><code>layouts/partials/topbar/func/button.html</code></a>).</p>
|
||
<p>Call this from yer own button templates if ye want t' implement a button without an overlay like th' <em>print</em> button (<a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html" target="_blank"><code>layouts/partials/topbar/button/print.html</code></a>) or wit' an overlay contain'n arbitrary rrrambl'n like th' <em>toc</em> button (<a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/toc.html" target="_blank"><code>layouts/partials/topbar/button/toc.html</code></a>).</p>
|
||
<p>For display'n an area 'n th' button’s overlay, see <a href="#area-button">Area-Button</a>.</p>
|
||
<h4 id="parameter">Parameter</h4>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>plank</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory reference t' th' plank.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>class</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory unique class name fer this button. Display'n two buttons wit' th' same value fer <strong>class</strong> be undefined.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>href</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click.<br><br>- if start'n wit' <code>javascript:</code> all follow'n text will be executed 'n yer browser<br>- every other str'n will be interpreted as URL<br>- if empty th' button will be displayed 'n disabled state regardless o' its <strong>rrrambl'n</strong></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>ay'con</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory <a href="../shortcodes/icon/index.html#finding-an-icon">Font Awesome ay'con name</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onempty</strong></td>
|
||
<td><code>dis'ble</code></td>
|
||
<td>Defines what t' do wit' th' button if <strong>href</strong> be not empty but th' rrrambl'n overlay be empty:<br><br>- <code>dis'ble</code>: Th' button be displayed 'n disabled state.<br>- <code>hide</code>: Th' button be removed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidths</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>Th' act'n, that should be executed if th' ship be displayed 'n th' given width:<br><br>- <code>show</code>: Th' button be displayed 'n its given area<br>- <code>hide</code>: Th' button be removed.<br>- <code>area-XXX</code>: Th' button be moved from its given area into th' area <code>XXX</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthm</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthl</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text fer title, displayed 'n th' tooltip.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>rrrambl'n</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary HTML t' put into th' rrrambl'n overlay. This parameter may be empty. In this case no overlay will be generated.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="area-button">Area-Button</h3>
|
||
<p>Contains th' basic functionality t' display area overlay buttons (<a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/func/area-button.html" target="_blank"><code>layouts/partials/topbar/func/area-button.html</code></a>).</p>
|
||
<p>Call this from yer own button templates if ye want t' implement a button wit' an area overlay like th' <em>more</em> button (<a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/more.html" target="_blank"><code>layouts/partials/topbar/button/more.html</code></a>).</p>
|
||
<h4 id="parameter-1">Parameter</h4>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>plank</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory reference t' th' plank.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>area</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory unique area name fer this area. Display'n two areas wit' th' same value fer <strong>area</strong> be undefined.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>ay'con</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory <a href="../shortcodes/icon/index.html#finding-an-icon">Font Awesome ay'con name</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onempty</strong></td>
|
||
<td><code>dis'ble</code></td>
|
||
<td>Defines what t' do wit' th' button if th' rrrambl'n overlay be empty:<br><br>- <code>dis'ble</code>: Th' button be displayed 'n disabled state.<br>- <code>hide</code>: Th' button be removed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidths</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>Th' act'n, that should be executed if th' ship be displayed 'n th' given width:<br><br>- <code>show</code>: Th' button be displayed 'n its given area<br>- <code>hide</code>: Th' button be removed.<br>- <code>area-XXX</code>: Th' button be moved from its given area into th' area <code>XXX</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthm</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthl</strong></td>
|
||
<td><code>show</code></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text fer title, displayed 'n th' tooltip.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="predefined-buttons">Predefined Buttons</h3>
|
||
<p>Th' predefined buttons by th' theme (all other buttons besides th' <em>more</em> an' <em>toc</em> button 'n <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button" target="_blank"><code>layouts/partials/topbar/button</code></a>).</p>
|
||
<p>Call these from yer own redefined area templates if ye want t' use default button behavior.</p>
|
||
<p>Th' <code><varying></code> parameter values be different fer each button an' configured fer standard behavior as seen on this plank.</p>
|
||
<h4 id="parameter-2">Parameter</h4>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>plank</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory reference t' th' plank.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidths</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>Th' act'n, that should be executed if th' ship be displayed 'n th' given width:<br><br>- <code>show</code>: Th' button be displayed 'n its given area<br>- <code>hide</code>: Th' button be removed.<br>- <code>area-XXX</code>: Th' button be moved from its given area into th' area <code>XXX</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthm</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthl</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="predefined-overlay-buttons">Predefined Overlay-Buttons</h3>
|
||
<p>Th' predefined buttons by th' theme that open an overlay (the <em>more</em> an' <em>toc</em> button 'n <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button" target="_blank"><code>layouts/partials/topbar/button</code></a>).</p>
|
||
<p>Call these from yer own redefined area templates if ye want t' use default button behavior utiliz'n overlay functionality.</p>
|
||
<p>Th' <code><varying></code> parameter values be different fer each button an' configured fer standard behavior as seen on this plank.</p>
|
||
<h4 id="parameter-3">Parameter</h4>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>plank</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory reference t' th' plank.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onempty</strong></td>
|
||
<td><code>dis'ble</code></td>
|
||
<td>Defines what t' do wit' th' button if th' rrrambl'n overlay be empty:<br><br>- <code>dis'ble</code>: Th' button be displayed 'n disabled state.<br>- <code>hide</code>: Th' button be removed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidths</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>Th' act'n, that should be executed if th' ship be displayed 'n th' given width:<br><br>- <code>show</code>: Th' button be displayed 'n its given area<br>- <code>hide</code>: Th' button be removed.<br>- <code>area-XXX</code>: Th' button be moved from its given area into th' area <code>XXX</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthm</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>onwidthl</strong></td>
|
||
<td><em><varying></em></td>
|
||
<td>See above.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="historrry">Historrry</h1>
|
||
|
||
|
||
<div class="include hide-first-heading">
|
||
<h1 id="changelog">Changelog</h1>
|
||
<h2 id="5232-2023-11-03">5.23.2 (2023-11-03)</h2>
|
||
<h3 id="enhancements">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] taxonomy: improve taxonomy plank <a href="https://github.com/McShelby/hugo-theme-relearn/issues/712" target="_blank">#712</a></li>
|
||
<li>[<strong>feature</strong>] taxonomy: warn on miss'n term title <a href="https://github.com/McShelby/hugo-theme-relearn/issues/709" target="_blank">#709</a></li>
|
||
</ul>
|
||
<h3 id="fixes">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] taxonomy: fix sort'n o' terms on rrrambl'n planks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/710" target="_blank">#710</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5231-2023-10-30">5.23.1 (2023-10-30)</h2>
|
||
<h3 id="enhancements-1">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] taxonomy: improve term plank <a href="https://github.com/McShelby/hugo-theme-relearn/issues/705" target="_blank">#705</a></li>
|
||
</ul>
|
||
<h3 id="fixes-1">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: fix typo 'n chroma-learn.css <a href="https://github.com/McShelby/hugo-theme-relearn/issues/708" target="_blank">#708</a></li>
|
||
<li>[<strong>bug</strong>] links: ignore local markdown links link'n t' files wit' extension <a href="https://github.com/McShelby/hugo-theme-relearn/issues/707" target="_blank">#707</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5230-2023-10-29">5.23.0 (2023-10-29)</h2>
|
||
<h3 id="enhancements-2">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] taxonomy: allow fer rrrambl'n on term planks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/701" target="_blank">#701</a></li>
|
||
<li>[<strong>feature</strong>] theme: write full file path on warnings <a href="https://github.com/McShelby/hugo-theme-relearn/issues/699" target="_blank">#699</a></li>
|
||
<li>[<strong>feature</strong>] theme: show anchor link an' copy t' clipboard button on mobile <a href="https://github.com/McShelby/hugo-theme-relearn/issues/697" target="_blank">#697</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] config: adjust t' changes 'n Hugo 0.120 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/693" target="_blank">#693</a></li>
|
||
<li>[<strong>feature</strong>] variants: add more contrast t' neon <a href="https://github.com/McShelby/hugo-theme-relearn/issues/692" target="_blank">#692</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: only show zoom reset button if zoomed <a href="https://github.com/McShelby/hugo-theme-relearn/issues/691" target="_blank">#691</a></li>
|
||
<li>[<strong>feature</strong>] menu: add additional sort opt'ns <a href="https://github.com/McShelby/hugo-theme-relearn/issues/684" target="_blank">#684</a></li>
|
||
<li>[<strong>feature</strong>] theme: add social media meta informat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/683" target="_blank">#683</a></li>
|
||
<li>[<strong>feature</strong>] theme: simplify additional JS dependencies <a href="https://github.com/McShelby/hugo-theme-relearn/issues/682" target="_blank">#682</a></li>
|
||
<li>[<strong>feature</strong>] links: warn if ref/relref be used falsly <a href="https://github.com/McShelby/hugo-theme-relearn/issues/681" target="_blank">#681</a></li>
|
||
<li>[<strong>feature</strong>] menu: make width configur'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/677" target="_blank">#677</a></li>
|
||
<li>[<strong>feature</strong>] tabs: use color fer link o' inactive tabs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/675" target="_blank">#675</a></li>
|
||
<li>[<strong>feature</strong>] taxonomy: modularize term list generat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/671" target="_blank">#671</a></li>
|
||
<li>[<strong>feature</strong>] theme: remove warnings wit' <code>hugo --printI18nWarn'ns</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/670" target="_blank">#670</a></li>
|
||
<li>[<strong>feature</strong>] theme: implement port'ble link'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/377" target="_blank">#377</a></li>
|
||
</ul>
|
||
<h3 id="fixes-2">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] links: extra space before link text <a href="https://github.com/McShelby/hugo-theme-relearn/issues/700" target="_blank">#700</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: reset zoom correctly <a href="https://github.com/McShelby/hugo-theme-relearn/issues/690" target="_blank">#690</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix mobile layout fer width=48rem <a href="https://github.com/McShelby/hugo-theme-relearn/issues/676" target="_blank">#676</a></li>
|
||
<li>[<strong>bug</strong>] frontmatter: resemble documented shortcode style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/672" target="_blank">#672</a></li>
|
||
<li>[<strong>bug</strong>] taxonomy: display terms 'n planks if <code>removePathAccents=true</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/669" target="_blank">#669</a></li>
|
||
</ul>
|
||
<h3 id="maintenance">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update mermaid t' 10.6.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/703" target="_blank">#703</a></li>
|
||
<li>[<strong>task</strong>] openapi: update swagger-ui t' 5.9.1 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/702" target="_blank">#702</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5221-2023-10-02">5.22.1 (2023-10-02)</h2>
|
||
<h3 id="enhancements-3">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Swahili translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/666" target="_blank">#666</a></li>
|
||
<li>[<strong>feature</strong>] math: hide unrendered math <a href="https://github.com/McShelby/hugo-theme-relearn/issues/663" target="_blank">#663</a></li>
|
||
<li>[<strong>feature</strong>] tabs: improve a11y by remov'n duplicate hidden title <a href="https://github.com/McShelby/hugo-theme-relearn/issues/662" target="_blank">#662</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: improve zoom UX <a href="https://github.com/McShelby/hugo-theme-relearn/issues/659" target="_blank">#659</a></li>
|
||
</ul>
|
||
<h3 id="fixes-3">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: fix sidebar-flyout borders color fer zen <a href="https://github.com/McShelby/hugo-theme-relearn/issues/667" target="_blank">#667</a></li>
|
||
<li>[<strong>bug</strong>] clipboard: fix RTL locat'n o' tooltip <a href="https://github.com/McShelby/hugo-theme-relearn/issues/661" target="_blank">#661</a></li>
|
||
<li>[<strong>bug</strong>] clipboard: ignore RTL fer code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/660" target="_blank">#660</a></li>
|
||
<li>[<strong>bug</strong>] expand: fix aria-controls <a href="https://github.com/McShelby/hugo-theme-relearn/issues/658" target="_blank">#658</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix id generat'n fer markdownified titles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/657" target="_blank">#657</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: avoid graph bomb'n on hugo –minify <a href="https://github.com/McShelby/hugo-theme-relearn/issues/656" target="_blank">#656</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: fix width fer some graphs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/655" target="_blank">#655</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5220-2023-09-26">5.22.0 (2023-09-26)</h2>
|
||
<h3 id="enhancements-4">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] mermaid: add pan&zoom reset <a href="https://github.com/McShelby/hugo-theme-relearn/issues/651" target="_blank">#651</a></li>
|
||
<li>[<strong>feature</strong>] markdown: add interlace color fer tables <a href="https://github.com/McShelby/hugo-theme-relearn/issues/648" target="_blank">#648</a></li>
|
||
<li>[<strong>feature</strong>] search: add breadcrumb t' dedicated search results <a href="https://github.com/McShelby/hugo-theme-relearn/issues/647" target="_blank">#647</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] menu: optionally dis'ble index planks fer sections <a href="https://github.com/McShelby/hugo-theme-relearn/issues/642" target="_blank">#642</a></li>
|
||
</ul>
|
||
<h3 id="fixes-4">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variants: restore generator zoom <a href="https://github.com/McShelby/hugo-theme-relearn/issues/650" target="_blank">#650</a></li>
|
||
<li>[<strong>bug</strong>] clipboard: malused Fontawesome style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/649" target="_blank">#649</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] theme: avoid id collisions between head'ns an' theme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/646" target="_blank">#646</a></li>
|
||
<li>[<strong>bug</strong>] theme: remove HTML validat'n errors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/644" target="_blank">#644</a></li>
|
||
<li>[<strong>bug</strong>] breadcrumb: remove superflous whitespace between items <a href="https://github.com/McShelby/hugo-theme-relearn/issues/643" target="_blank">#643</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5210-2023-09-18">5.21.0 (2023-09-18)</h2>
|
||
<h3 id="enhancements-5">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] topbar: make buttons configur'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/639" target="_blank">#639</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] menu: fix footer padd'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/637" target="_blank">#637</a></li>
|
||
</ul>
|
||
<h3 id="fixes-5">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] breadcrumb: don’t ignore spaces fer separator <a href="https://github.com/McShelby/hugo-theme-relearn/issues/636" target="_blank">#636</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix snyk code issues <a href="https://github.com/McShelby/hugo-theme-relearn/issues/633" target="_blank">#633</a></li>
|
||
<li>[<strong>bug</strong>] images: apply image effects t' lightbox images <a href="https://github.com/McShelby/hugo-theme-relearn/issues/631" target="_blank">#631</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-1">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] openapi: update t' swagger 5.7.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/641" target="_blank">#641</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5200-2023-08-26">5.20.0 (2023-08-26)</h2>
|
||
<h3 id="enhancements-6">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: support fer colored borders between menu an' rrrambl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/626" target="_blank">#626</a></li>
|
||
<li>[<strong>feature</strong>] image: allow opt'n t' apply image effects globally <a href="https://github.com/McShelby/hugo-theme-relearn/issues/623" target="_blank">#623</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] openapi: switch t' light syntaxhighlightn'n whar' applic'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/621" target="_blank">#621</a></li>
|
||
<li>[<strong>feature</strong>] images: document usage o' images wit' links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/576" target="_blank">#576</a></li>
|
||
</ul>
|
||
<h3 id="fixes-6">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] highlight: fix render'n fer Cap'n Hugo < 0.111 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/630" target="_blank">#630</a></li>
|
||
<li>[<strong>bug</strong>] search: remove link underline on dedicated search plank <a href="https://github.com/McShelby/hugo-theme-relearn/issues/627" target="_blank">#627</a></li>
|
||
<li>[<strong>bug</strong>] highlight: don’t switch t' block view if hl_inline=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/618" target="_blank">#618</a></li>
|
||
<li>[<strong>bug</strong>] variant: minor adjustments t' zen variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/617" target="_blank">#617</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: lazy render graph if it be initially hidden <a href="https://github.com/McShelby/hugo-theme-relearn/issues/187" target="_blank">#187</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-2">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] openapi: update t' swagger 5.4.1 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/620" target="_blank">#620</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5190-2023-08-12">5.19.0 (2023-08-12)</h2>
|
||
<h3 id="enhancements-7">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] highlight: add title parameter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/616" target="_blank">#616</a></li>
|
||
<li>[<strong>feature</strong>] variant: signal variant switch as event <a href="https://github.com/McShelby/hugo-theme-relearn/issues/614" target="_blank">#614</a></li>
|
||
<li>[<strong>feature</strong>] variant: add zen variant 'n light an' dark <a href="https://github.com/McShelby/hugo-theme-relearn/issues/613" target="_blank">#613</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add Hungarian translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/604" target="_blank">#604</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: update t' 10.3.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/601" target="_blank">#601</a></li>
|
||
</ul>
|
||
<h3 id="fixes-7">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] siteparam: avoid halt if param be a map/slice <a href="https://github.com/McShelby/hugo-theme-relearn/issues/611" target="_blank">#611</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: fix broken zoom since update t' v10 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/608" target="_blank">#608</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: variant generator diagram does not respond t' events <a href="https://github.com/McShelby/hugo-theme-relearn/issues/607" target="_blank">#607</a></li>
|
||
<li>[<strong>bug</strong>] print: avoid chroma leak fer relearn-dark <a href="https://github.com/McShelby/hugo-theme-relearn/issues/605" target="_blank">#605</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-3">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update t' 10.3.1 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/610" target="_blank">#610</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5180-2023-07-27">5.18.0 (2023-07-27)</h2>
|
||
<h3 id="enhancements-8">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] shorrrtcodes: add more deprecat'n warnings <a href="https://github.com/McShelby/hugo-theme-relearn/issues/598" target="_blank">#598</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] shorrrtcodes: change <code>context</code> parameter t' <code>plank</code> if called as partial <a href="https://github.com/McShelby/hugo-theme-relearn/issues/595" target="_blank">#595</a></li>
|
||
<li>[<strong>feature</strong>] siteparam: support nested parameters an' text formatt'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/590" target="_blank">#590</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] a11y: improve when tabb'n thru links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/581" target="_blank">#581</a></li>
|
||
</ul>
|
||
<h3 id="fixes-8">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] openapi: inherit RTL sett'n from Cap'n Hugo rrrambl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/600" target="_blank">#600</a></li>
|
||
<li>[<strong>bug</strong>] 404: fix display 'n RTL <a href="https://github.com/McShelby/hugo-theme-relearn/issues/597" target="_blank">#597</a></li>
|
||
<li>[<strong>bug</strong>] highlight: fix posit'n o' copy-to-clipboard button 'n RTL <a href="https://github.com/McShelby/hugo-theme-relearn/issues/594" target="_blank">#594</a></li>
|
||
<li>[<strong>bug</strong>] openapi: fix spell'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/593" target="_blank">#593</a></li>
|
||
<li>[<strong>bug</strong>] search: fix typo 'n output format <a href="https://github.com/McShelby/hugo-theme-relearn/issues/591" target="_blank">#591</a></li>
|
||
<li>[<strong>bug</strong>] tabs: fix tab select'n by groupid <a href="https://github.com/McShelby/hugo-theme-relearn/issues/582" target="_blank">#582</a></li>
|
||
<li>[<strong>bug</strong>] theme: restore compat wit' Cap'n Hugo 0.95.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/580" target="_blank">#580</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] theme: improve display o' links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/577" target="_blank">#577</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5171-2023-06-22">5.17.1 (2023-06-22)</h2>
|
||
<h3 id="enhancements-9">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] highlight: make copy t' clipboard appear on hover <a href="https://github.com/McShelby/hugo-theme-relearn/issues/574" target="_blank">#574</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5170-2023-06-22">5.17.0 (2023-06-22)</h2>
|
||
<h3 id="enhancements-10">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] highlight: add configur'ble line breaks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/169" target="_blank">#169</a></li>
|
||
</ul>
|
||
<h3 id="fixes-9">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: support Cap'n Hugo 0.114.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/573" target="_blank">#573</a></li>
|
||
<li>[<strong>bug</strong>] taxonomy: fix number tags <a href="https://github.com/McShelby/hugo-theme-relearn/issues/570" target="_blank">#570</a></li>
|
||
<li>[<strong>bug</strong>] highlight: improve copy t' clipboard <a href="https://github.com/McShelby/hugo-theme-relearn/issues/569" target="_blank">#569</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5162-2023-06-10">5.16.2 (2023-06-10)</h2>
|
||
<h3 id="enhancements-11">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: revamp 404 plank <a href="https://github.com/McShelby/hugo-theme-relearn/issues/566" target="_blank">#566</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5161-2023-06-09">5.16.1 (2023-06-09)</h2>
|
||
<h3 id="enhancements-12">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: add deprecat'n warnings <a href="https://github.com/McShelby/hugo-theme-relearn/issues/565" target="_blank">#565</a></li>
|
||
</ul>
|
||
<h3 id="fixes-10">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: allow fer YAML frontmatter inside o' graph <a href="https://github.com/McShelby/hugo-theme-relearn/issues/564" target="_blank">#564</a></li>
|
||
<li>[<strong>bug</strong>] alias: fix redirect URLs 'n case o' empty BaseURL <a href="https://github.com/McShelby/hugo-theme-relearn/issues/562" target="_blank">#562</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5160-2023-06-08">5.16.0 (2023-06-08)</h2>
|
||
<h3 id="enhancements-13">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tabs: add title an' ay'con opt'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/552" target="_blank">#552</a></li>
|
||
<li>[<strong>feature</strong>] shorrrtcodes: add style opt'n t' mimic code box color scheme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/551" target="_blank">#551</a></li>
|
||
<li>[<strong>feature</strong>] tabs: support color opt'ns <a href="https://github.com/McShelby/hugo-theme-relearn/issues/550" target="_blank">#550</a></li>
|
||
<li>[<strong>feature</strong>] favicon: add light & dark opt'n fer OS’s prefered color scheme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/549" target="_blank">#549</a></li>
|
||
</ul>
|
||
<h3 id="fixes-11">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] ay'con: remove whitespace on start <a href="https://github.com/McShelby/hugo-theme-relearn/issues/560" target="_blank">#560</a></li>
|
||
<li>[<strong>bug</strong>] shorrrtcodes: avoid superflous margin at start an' end o' rrrambl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/558" target="_blank">#558</a></li>
|
||
<li>[<strong>bug</strong>] expand: fix html encod'n o' finish'n rrrambl'n tag <a href="https://github.com/McShelby/hugo-theme-relearn/issues/557" target="_blank">#557</a></li>
|
||
<li>[<strong>bug</strong>] ay'con: fix ouput “raw HTML omitted” wit' goldmark config unsafe=false <a href="https://github.com/McShelby/hugo-theme-relearn/issues/555" target="_blank">#555</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5152-2023-05-29">5.15.2 (2023-05-29)</h2>
|
||
<h3 id="enhancements-14">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] taxonomy: add support fer category default taxonomy <a href="https://github.com/McShelby/hugo-theme-relearn/issues/541" target="_blank">#541</a></li>
|
||
</ul>
|
||
<h3 id="fixes-12">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: work fer Cap'n Hugo < 0.112 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/546" target="_blank">#546</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5151-2023-05-25">5.15.1 (2023-05-25)</h2>
|
||
<h3 id="fixes-13">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] shorrrtcodes: intermediately use random ids instead o' .Ordinal <a href="https://github.com/McShelby/hugo-theme-relearn/issues/543" target="_blank">#543</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5150-2023-05-25">5.15.0 (2023-05-25)</h2>
|
||
<h3 id="enhancements-15">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tab: new shortcode t' display single tab <a href="https://github.com/McShelby/hugo-theme-relearn/issues/538" target="_blank">#538</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] tabs: treat groupid as unique if not set <a href="https://github.com/McShelby/hugo-theme-relearn/issues/537" target="_blank">#537</a></li>
|
||
<li>[<strong>feature</strong>] expand: indent expanded rrrambl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/536" target="_blank">#536</a></li>
|
||
<li>[<strong>feature</strong>] notice: make boxes more prominent <a href="https://github.com/McShelby/hugo-theme-relearn/issues/535" target="_blank">#535</a></li>
|
||
</ul>
|
||
<h3 id="fixes-14">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: fix build error since Cap'n Hugo 0.112 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/540" target="_blank">#540</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-4">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] chore: update Merrrmaid t' 9.4.3 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/534" target="_blank">#534</a></li>
|
||
<li>[<strong>task</strong>] mermaid: update t' 10.2.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/499" target="_blank">#499</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5143-2023-05-20">5.14.3 (2023-05-20)</h2>
|
||
<h3 id="fixes-15">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tags: show taxonomy toc fer standard installat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/533" target="_blank">#533</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5142-2023-05-20">5.14.2 (2023-05-20)</h2>
|
||
<h3 id="fixes-16">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tags: translate breadcrumb an' title fer taxonomy <a href="https://github.com/McShelby/hugo-theme-relearn/issues/532" target="_blank">#532</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5141-2023-05-20">5.14.1 (2023-05-20)</h2>
|
||
<p><em>No changelog fer this release.</em></p>
|
||
<hr>
|
||
<h2 id="5140-2023-05-19">5.14.0 (2023-05-19)</h2>
|
||
<h3 id="enhancements-16">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tags: improve search index fer tags <a href="https://github.com/McShelby/hugo-theme-relearn/issues/531" target="_blank">#531</a></li>
|
||
<li>[<strong>feature</strong>] tags: increase readability o' taxonomy planks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/530" target="_blank">#530</a></li>
|
||
<li>[<strong>feature</strong>] nav: make breadcrumb separator configur'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/529" target="_blank">#529</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add translat'n fer default taxonomies <a href="https://github.com/McShelby/hugo-theme-relearn/issues/528" target="_blank">#528</a></li>
|
||
<li>[<strong>feature</strong>] theme: set appropriate defaults fer all theme specific params <a href="https://github.com/McShelby/hugo-theme-relearn/issues/516" target="_blank">#516</a></li>
|
||
<li>[<strong>feature</strong>] theme: allow t' display tags below article <a href="https://github.com/McShelby/hugo-theme-relearn/issues/513" target="_blank">#513</a></li>
|
||
</ul>
|
||
<h3 id="fixes-17">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] shortcode: make .context always a plank <a href="https://github.com/McShelby/hugo-theme-relearn/issues/527" target="_blank">#527</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5132-2023-05-17">5.13.2 (2023-05-17)</h2>
|
||
<h3 id="fixes-18">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: en'ble print fer planks wit' _build opt'ns <a href="https://github.com/McShelby/hugo-theme-relearn/issues/522" target="_blank">#522</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5131-2023-05-16">5.13.1 (2023-05-16)</h2>
|
||
<h3 id="fixes-19">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] openapi: allow toc t' scroll plank <a href="https://github.com/McShelby/hugo-theme-relearn/issues/526" target="_blank">#526</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5130-2023-05-14">5.13.0 (2023-05-14)</h2>
|
||
<h3 id="enhancements-17">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] openapi: replace implementat'n wit' swagger-ui <a href="https://github.com/McShelby/hugo-theme-relearn/issues/523" target="_blank">#523</a></li>
|
||
</ul>
|
||
<h3 id="fixes-20">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: avoid leak'n shadows 'n neon print style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/524" target="_blank">#524</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5126-2023-05-04">5.12.6 (2023-05-04)</h2>
|
||
<h3 id="enhancements-18">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: better HTML titles an' breadcrumbs fer search an' tag planks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/521" target="_blank">#521</a></li>
|
||
</ul>
|
||
<h3 id="fixes-21">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: avoid hid'n o' expander on hover when active item has children <a href="https://github.com/McShelby/hugo-theme-relearn/issues/520" target="_blank">#520</a></li>
|
||
<li>[<strong>bug</strong>] menu: showVisitedLinks not work'n fer some theme variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/518" target="_blank">#518</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix resource URLs fer 404 plank on subdirectories <a href="https://github.com/McShelby/hugo-theme-relearn/issues/515" target="_blank">#515</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5125-2023-03-28">5.12.5 (2023-03-28)</h2>
|
||
<h3 id="fixes-22">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] expand: not properly exanded when used 'n bullet point list <a href="https://github.com/McShelby/hugo-theme-relearn/issues/508" target="_blank">#508</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5124-2023-03-24">5.12.4 (2023-03-24)</h2>
|
||
<h3 id="fixes-23">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: disableExplicitIndexURLs param be not work'n as expected <a href="https://github.com/McShelby/hugo-theme-relearn/issues/505" target="_blank">#505</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5123-2023-03-14">5.12.3 (2023-03-14)</h2>
|
||
<h3 id="fixes-24">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: fix links if only one language be present <a href="https://github.com/McShelby/hugo-theme-relearn/issues/503" target="_blank">#503</a></li>
|
||
<li>[<strong>bug</strong>] shorrrtcodes: allow markdown fer title an' rrrambl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/502" target="_blank">#502</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5122-2023-03-03">5.12.2 (2023-03-03)</h2>
|
||
<h3 id="fixes-25">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: fix state fer alwaysopen=false + collapsibleMenu=false <a href="https://github.com/McShelby/hugo-theme-relearn/issues/498" target="_blank">#498</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5121-2023-02-26">5.12.1 (2023-02-26)</h2>
|
||
<h3 id="enhancements-19">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] variant: add relearn bright theme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/493" target="_blank">#493</a></li>
|
||
</ul>
|
||
<h3 id="fixes-26">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] generator: fix sett'n o' colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/494" target="_blank">#494</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5120-2023-02-24">5.12.0 (2023-02-24)</h2>
|
||
<h3 id="enhancements-20">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] frontmatter: support VSCode Front Matter extension <a href="https://github.com/McShelby/hugo-theme-relearn/issues/481" target="_blank">#481</a></li>
|
||
<li>[<strong>feature</strong>] theme: make expand an' image ids st'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/477" target="_blank">#477</a></li>
|
||
<li>[<strong>feature</strong>] variant: set scrollbar color t' dark fer dark variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/471" target="_blank">#471</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add full RTL support <a href="https://github.com/McShelby/hugo-theme-relearn/issues/470" target="_blank">#470</a></li>
|
||
<li>[<strong>feature</strong>] piratify: fix some quirks, arrr <a href="https://github.com/McShelby/hugo-theme-relearn/issues/469" target="_blank">#469</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: optimizat'n fer huge screen sizes <a href="https://github.com/McShelby/hugo-theme-relearn/issues/466" target="_blank">#466</a></li>
|
||
</ul>
|
||
<h3 id="fixes-27">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] i18n: write code ltr even fer rtl languages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/492" target="_blank">#492</a></li>
|
||
<li>[<strong>bug</strong>] anchor: fix link 'n FF when served from filesystem <a href="https://github.com/McShelby/hugo-theme-relearn/issues/482" target="_blank">#482</a></li>
|
||
<li>[<strong>bug</strong>] shorrrtcodes: don’t break build an' render fer invalid parameters <a href="https://github.com/McShelby/hugo-theme-relearn/issues/480" target="_blank">#480</a></li>
|
||
<li>[<strong>bug</strong>] nav: restore scroll posit'n on browser back <a href="https://github.com/McShelby/hugo-theme-relearn/issues/476" target="_blank">#476</a></li>
|
||
<li>[<strong>bug</strong>] variant: avoid style leak fer auto style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/473" target="_blank">#473</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-5">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: add imagebot <a href="https://github.com/McShelby/hugo-theme-relearn/issues/485" target="_blank">#485</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5112-2023-02-07">5.11.2 (2023-02-07)</h2>
|
||
<h3 id="fixes-28">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tabs: nested tabs rrrambl'n be not displayed <a href="https://github.com/McShelby/hugo-theme-relearn/issues/468" target="_blank">#468</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5111-2023-02-06">5.11.1 (2023-02-06)</h2>
|
||
<h3 id="fixes-29">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: include miss'n <code>theme-auto.css</code> 'n distribut'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/467" target="_blank">#467</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5110-2023-02-05">5.11.0 (2023-02-05)</h2>
|
||
<h3 id="enhancements-21">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Czech translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/455" target="_blank">#455</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] lightbox: switch t' CSS-only solut'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/451" target="_blank">#451</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] variant: add support fer <code>prefers-color-scheme</code> <a href="https://github.com/McShelby/hugo-theme-relearn/issues/445" target="_blank">#445</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] expand: refactor fer a11y <a href="https://github.com/McShelby/hugo-theme-relearn/issues/339" target="_blank">#339</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] mermaid: make zoom configur'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/144" target="_blank">#144</a></li>
|
||
</ul>
|
||
<h3 id="fixes-30">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: avoid errors when us'n invalid rapi-doc fragment ids <a href="https://github.com/McShelby/hugo-theme-relearn/issues/465" target="_blank">#465</a></li>
|
||
<li>[<strong>bug</strong>] search: fix oddities 'n keyboard handl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/463" target="_blank">#463</a></li>
|
||
<li>[<strong>bug</strong>] badge: fix text color fer IE11 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/462" target="_blank">#462</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: rerender graph if search term be present an' variant be switched <a href="https://github.com/McShelby/hugo-theme-relearn/issues/460" target="_blank">#460</a></li>
|
||
<li>[<strong>bug</strong>] tags: show tag on planks when tag has space <a href="https://github.com/McShelby/hugo-theme-relearn/issues/459" target="_blank">#459</a></li>
|
||
<li>[<strong>bug</strong>] edit: remove do'ble slash on root plank link <a href="https://github.com/McShelby/hugo-theme-relearn/issues/450" target="_blank">#450</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-6">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: add mov'n version tags <a href="https://github.com/McShelby/hugo-theme-relearn/issues/453" target="_blank">#453</a></li>
|
||
<li>[<strong>task</strong>][<strong>change</strong>] theme: remove jQuery <a href="https://github.com/McShelby/hugo-theme-relearn/issues/452" target="_blank">#452</a></li>
|
||
<li>[<strong>task</strong>] build: check fer release notes before release <a href="https://github.com/McShelby/hugo-theme-relearn/issues/448" target="_blank">#448</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5102-2023-01-25">5.10.2 (2023-01-25)</h2>
|
||
<h3 id="fixes-31">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: fix breadcrumb fer huge installat'ns <a href="https://github.com/McShelby/hugo-theme-relearn/issues/446" target="_blank">#446</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5101-2023-01-25">5.10.1 (2023-01-25)</h2>
|
||
<h3 id="fixes-32">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix image links wit' relative path <a href="https://github.com/McShelby/hugo-theme-relearn/issues/444" target="_blank">#444</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5100-2023-01-25">5.10.0 (2023-01-25)</h2>
|
||
<h3 id="enhancements-22">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] shorrrtcodes: support fer accent color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/440" target="_blank">#440</a></li>
|
||
<li>[<strong>feature</strong>] shorrrtcodes: add color parameter whar' applic'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/438" target="_blank">#438</a></li>
|
||
<li>[<strong>feature</strong>] theme: announce translat'ns as alternate links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/422" target="_blank">#422</a></li>
|
||
</ul>
|
||
<h3 id="fixes-33">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: fix breadcrumbs fer deeply nested sections <a href="https://github.com/McShelby/hugo-theme-relearn/issues/442" target="_blank">#442</a></li>
|
||
<li>[<strong>bug</strong>] theme: improve whitespac'n 'n tables <a href="https://github.com/McShelby/hugo-theme-relearn/issues/441" target="_blank">#441</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="594-2023-01-23">5.9.4 (2023-01-23)</h2>
|
||
<h3 id="fixes-34">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: fix search ay'con an' text color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/437" target="_blank">#437</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="593-2023-01-22">5.9.3 (2023-01-22)</h2>
|
||
<h3 id="fixes-35">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: fix left/right navigat'n fer horizontal scroll'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/435" target="_blank">#435</a></li>
|
||
<li>[<strong>bug</strong>][<strong>break'n</strong>] theme: allow planks on top level <a href="https://github.com/McShelby/hugo-theme-relearn/issues/434" target="_blank">#434</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-7">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: switch t' wildcard version o' act'ns <a href="https://github.com/McShelby/hugo-theme-relearn/issues/428" target="_blank">#428</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="592-2022-12-30">5.9.2 (2022-12-30)</h2>
|
||
<h3 id="fixes-36">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: apply dependency scripts fer Hindi an' Japanese <a href="https://github.com/McShelby/hugo-theme-relearn/issues/427" target="_blank">#427</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="591-2022-12-23">5.9.1 (2022-12-23)</h2>
|
||
<h3 id="enhancements-23">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: make external link target configur'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/426" target="_blank">#426</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="590-2022-12-23">5.9.0 (2022-12-23)</h2>
|
||
<h3 id="enhancements-24">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: open external links 'n separate tab <a href="https://github.com/McShelby/hugo-theme-relearn/issues/419" target="_blank">#419</a></li>
|
||
<li>[<strong>feature</strong>] theme: make it a Cap'n Hugo module <a href="https://github.com/McShelby/hugo-theme-relearn/issues/417" target="_blank">#417</a></li>
|
||
</ul>
|
||
<h3 id="fixes-37">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] attachments: fix incorrect links fer defaultContentLanguageInSubdir=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/425" target="_blank">#425</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="581-2022-12-11">5.8.1 (2022-12-11)</h2>
|
||
<h3 id="fixes-38">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix alias fer home plank if defaultContentLanguageInSubdir=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/414" target="_blank">#414</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="580-2022-12-08">5.8.0 (2022-12-08)</h2>
|
||
<h3 id="enhancements-25">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] ay'con: add new shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/412" target="_blank">#412</a></li>
|
||
<li>[<strong>feature</strong>] theme: style an' document markdown extensions <a href="https://github.com/McShelby/hugo-theme-relearn/issues/411" target="_blank">#411</a></li>
|
||
<li>[<strong>feature</strong>] badge: add new shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/410" target="_blank">#410</a></li>
|
||
<li>[<strong>feature</strong>] theme: add accent color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/409" target="_blank">#409</a></li>
|
||
</ul>
|
||
<h3 id="fixes-39">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix spac'n fer tag flyout 'n FF <a href="https://github.com/McShelby/hugo-theme-relearn/issues/413" target="_blank">#413</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="570-2022-11-29">5.7.0 (2022-11-29)</h2>
|
||
<h3 id="enhancements-26">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] button: refactor fer a11y <a href="https://github.com/McShelby/hugo-theme-relearn/issues/372" target="_blank">#372</a></li>
|
||
</ul>
|
||
<h3 id="fixes-40">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: don’t freeze browser on long search terms <a href="https://github.com/McShelby/hugo-theme-relearn/issues/408" target="_blank">#408</a></li>
|
||
<li>[<strong>bug</strong>] search: fix searchbox placeholder color 'n FF an' IE <a href="https://github.com/McShelby/hugo-theme-relearn/issues/405" target="_blank">#405</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] i18n: rename Korean translat'n from country t' lang code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/404" target="_blank">#404</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-8">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] search: update lunr languages t' 1.10.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/403" target="_blank">#403</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="566-2022-11-23">5.6.6 (2022-11-23)</h2>
|
||
<h3 id="enhancements-27">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] search: make build an' js forgiv'n against config errors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/400" target="_blank">#400</a></li>
|
||
</ul>
|
||
<h3 id="fixes-41">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: minor color adjustments <a href="https://github.com/McShelby/hugo-theme-relearn/issues/402" target="_blank">#402</a></li>
|
||
<li>[<strong>bug</strong>] variant: fix generator fer use o' neon <a href="https://github.com/McShelby/hugo-theme-relearn/issues/401" target="_blank">#401</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="565-2022-11-19">5.6.5 (2022-11-19)</h2>
|
||
<h3 id="fixes-42">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: relax usage o' background color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/399" target="_blank">#399</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="564-2022-11-19">5.6.4 (2022-11-19)</h2>
|
||
<h3 id="fixes-43">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: make alias planks us'ble by file:// protocol <a href="https://github.com/McShelby/hugo-theme-relearn/issues/398" target="_blank">#398</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="563-2022-11-19">5.6.3 (2022-11-19)</h2>
|
||
<h3 id="fixes-44">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: be compat'ble wit' Cap'n Hugo >= 0.95.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/397" target="_blank">#397</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="562-2022-11-19">5.6.2 (2022-11-19)</h2>
|
||
<h3 id="fixes-45">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: build breaks sites without “output” section 'n config <a href="https://github.com/McShelby/hugo-theme-relearn/issues/396" target="_blank">#396</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="561-2022-11-19">5.6.1 (2022-11-19)</h2>
|
||
<h3 id="fixes-46">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix image distort'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/395" target="_blank">#395</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="560-2022-11-18">5.6.0 (2022-11-18)</h2>
|
||
<h3 id="enhancements-28">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] toc: improve keyboard handl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/390" target="_blank">#390</a></li>
|
||
<li>[<strong>feature</strong>] search: improve keyboard handl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/387" target="_blank">#387</a></li>
|
||
<li>[<strong>feature</strong>] search: add dedicated search plank <a href="https://github.com/McShelby/hugo-theme-relearn/issues/386" target="_blank">#386</a></li>
|
||
<li>[<strong>feature</strong>] theme: make creat'n o' generator meta tag configur'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/383" target="_blank">#383</a></li>
|
||
<li>[<strong>feature</strong>] theme: increase build performance <a href="https://github.com/McShelby/hugo-theme-relearn/issues/380" target="_blank">#380</a></li>
|
||
</ul>
|
||
<h3 id="fixes-47">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: avoid lead'n whitespace <a href="https://github.com/McShelby/hugo-theme-relearn/issues/394" target="_blank">#394</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix build errors when referenc'n SVGs 'n markdown <a href="https://github.com/McShelby/hugo-theme-relearn/issues/393" target="_blank">#393</a></li>
|
||
<li>[<strong>bug</strong>] variant: avoid neon t' leak into IE11 fallback <a href="https://github.com/McShelby/hugo-theme-relearn/issues/392" target="_blank">#392</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix urls fer file:// protocol 'n sitemap <a href="https://github.com/McShelby/hugo-theme-relearn/issues/385" target="_blank">#385</a></li>
|
||
<li>[<strong>bug</strong>] theme: add id t' h1 elements <a href="https://github.com/McShelby/hugo-theme-relearn/issues/384" target="_blank">#384</a></li>
|
||
<li>[<strong>bug</strong>] rss: fix display o' hidden subpages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/382" target="_blank">#382</a></li>
|
||
<li>[<strong>bug</strong>] nav: fix key navigat'n when press'n wrong modifiers <a href="https://github.com/McShelby/hugo-theme-relearn/issues/379" target="_blank">#379</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-9">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update t' version 9.2.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/391" target="_blank">#391</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="553-2022-11-10">5.5.3 (2022-11-10)</h2>
|
||
<h3 id="fixes-48">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tags: fix non-latin tag display on planks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/378" target="_blank">#378</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="552-2022-11-08">5.5.2 (2022-11-08)</h2>
|
||
<h3 id="fixes-49">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix typo 'n 404.html <a href="https://github.com/McShelby/hugo-theme-relearn/issues/376" target="_blank">#376</a></li>
|
||
<li>[<strong>bug</strong>] theme: allow menu items an' children t' be served by file:// protocol <a href="https://github.com/McShelby/hugo-theme-relearn/issues/375" target="_blank">#375</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="551-2022-11-07">5.5.1 (2022-11-07)</h2>
|
||
<h3 id="fixes-50">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix overflow'n issue wit' anchors an' tooltips <a href="https://github.com/McShelby/hugo-theme-relearn/issues/364" target="_blank">#364</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="550-2022-11-06">5.5.0 (2022-11-06)</h2>
|
||
<h3 id="enhancements-29">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: opt'mize plank board fer images <a href="https://github.com/McShelby/hugo-theme-relearn/issues/304" target="_blank">#304</a></li>
|
||
</ul>
|
||
<h3 id="fixes-51">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix context 'n render hooks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/373" target="_blank">#373</a></li>
|
||
<li>[<strong>bug</strong>] print: make canonical URL absolute <a href="https://github.com/McShelby/hugo-theme-relearn/issues/371" target="_blank">#371</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="543-2022-11-05">5.4.3 (2022-11-05)</h2>
|
||
<h3 id="enhancements-30">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] history: refactor fer a11y <a href="https://github.com/McShelby/hugo-theme-relearn/issues/341" target="_blank">#341</a></li>
|
||
</ul>
|
||
<h3 id="fixes-52">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix multilang links when ship served from subdirectory <a href="https://github.com/McShelby/hugo-theme-relearn/issues/370" target="_blank">#370</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="542-2022-11-05">5.4.2 (2022-11-05)</h2>
|
||
<h3 id="maintenance-10">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: change set-output t' env vars <a href="https://github.com/McShelby/hugo-theme-relearn/issues/348" target="_blank">#348</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="541-2022-11-05">5.4.1 (2022-11-05)</h2>
|
||
<h3 id="fixes-53">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: fix Gantt chart width <a href="https://github.com/McShelby/hugo-theme-relearn/issues/365" target="_blank">#365</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="540-2022-11-01">5.4.0 (2022-11-01)</h2>
|
||
<h3 id="enhancements-31">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] math: allow pass'n o' parameters wit' codefence rules <a href="https://github.com/McShelby/hugo-theme-relearn/issues/363" target="_blank">#363</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add Finnish translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/361" target="_blank">#361</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: allow pass'n o' parameters wit' codefence rules <a href="https://github.com/McShelby/hugo-theme-relearn/issues/360" target="_blank">#360</a></li>
|
||
<li>[<strong>feature</strong>] i18n: support RTL <a href="https://github.com/McShelby/hugo-theme-relearn/issues/357" target="_blank">#357</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] button: add opt'n fer target <a href="https://github.com/McShelby/hugo-theme-relearn/issues/351" target="_blank">#351</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: allow t' be served by file:// protocol <a href="https://github.com/McShelby/hugo-theme-relearn/issues/349" target="_blank">#349</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="533-2022-10-09">5.3.3 (2022-10-09)</h2>
|
||
<h3 id="fixes-54">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] archetypes: fix frontmatter on home.md template <a href="https://github.com/McShelby/hugo-theme-relearn/issues/346" target="_blank">#346</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="532-2022-10-08">5.3.2 (2022-10-08)</h2>
|
||
<h3 id="fixes-55">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: change defunct keyboard shortcuts <a href="https://github.com/McShelby/hugo-theme-relearn/issues/344" target="_blank">#344</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="531-2022-10-08">5.3.1 (2022-10-08)</h2>
|
||
<h3 id="enhancements-32">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: update Spanish translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/343" target="_blank">#343</a></li>
|
||
<li>[<strong>feature</strong>] theme: opt'n t' align images <a href="https://github.com/McShelby/hugo-theme-relearn/issues/327" target="_blank">#327</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="530-2022-10-07">5.3.0 (2022-10-07)</h2>
|
||
<h3 id="enhancements-33">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] expander: improve whitespace between label an' rrrambl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/338" target="_blank">#338</a></li>
|
||
<li>[<strong>feature</strong>] swagger: improve print version <a href="https://github.com/McShelby/hugo-theme-relearn/issues/333" target="_blank">#333</a></li>
|
||
</ul>
|
||
<h3 id="fixes-56">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix links o' subsections <a href="https://github.com/McShelby/hugo-theme-relearn/issues/340" target="_blank">#340</a></li>
|
||
<li>[<strong>bug</strong>] theme: remove W3C validator errors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/337" target="_blank">#337</a></li>
|
||
<li>[<strong>bug</strong>] children: remove unused <code>plank</code> parameter from docs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/336" target="_blank">#336</a></li>
|
||
<li>[<strong>bug</strong>] print: remove menu placeholder 'n Firefox <a href="https://github.com/McShelby/hugo-theme-relearn/issues/335" target="_blank">#335</a></li>
|
||
<li>[<strong>bug</strong>] swagger: fix download button overflow <a href="https://github.com/McShelby/hugo-theme-relearn/issues/334" target="_blank">#334</a></li>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] a11y: remove WCAG errors whar' applic'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/307" target="_blank">#307</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="524-2022-10-02">5.2.4 (2022-10-02)</h2>
|
||
<h3 id="fixes-57">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: remove HTML5 validator errors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/329" target="_blank">#329</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="523-2022-09-12">5.2.3 (2022-09-12)</h2>
|
||
<h3 id="fixes-58">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: chapter planks overwrite font-size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/328" target="_blank">#328</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="522-2022-08-23">5.2.2 (2022-08-23)</h2>
|
||
<h3 id="fixes-59">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix urls fer uglyURLs=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/322" target="_blank">#322</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="521-2022-08-05">5.2.1 (2022-08-05)</h2>
|
||
<h3 id="enhancements-34">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: improve Japanese translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/318" target="_blank">#318</a></li>
|
||
</ul>
|
||
<h3 id="fixes-60">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: prev/next ignores ordersectionby <a href="https://github.com/McShelby/hugo-theme-relearn/issues/320" target="_blank">#320</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-11">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] task: bump Cap'n Hugo minimum requirement t' 0.95 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/319" target="_blank">#319</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="520-2022-08-03">5.2.0 (2022-08-03)</h2>
|
||
<h3 id="enhancements-35">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] menu: expand collapsed menus if search term be found 'n submenus <a href="https://github.com/McShelby/hugo-theme-relearn/issues/312" target="_blank">#312</a></li>
|
||
</ul>
|
||
<h3 id="fixes-61">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: switch mermaid an' swagger style before print <a href="https://github.com/McShelby/hugo-theme-relearn/issues/316" target="_blank">#316</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix chapter margins on big screens <a href="https://github.com/McShelby/hugo-theme-relearn/issues/315" target="_blank">#315</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="512-2022-07-18">5.1.2 (2022-07-18)</h2>
|
||
<h3 id="fixes-62">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: reset mermaid theme t' light <a href="https://github.com/McShelby/hugo-theme-relearn/issues/313" target="_blank">#313</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: header be show'n up 'n FF <a href="https://github.com/McShelby/hugo-theme-relearn/issues/311" target="_blank">#311</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="511-2022-07-15">5.1.1 (2022-07-15)</h2>
|
||
<h3 id="fixes-63">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tags: don’t count tags if plank be hidden <a href="https://github.com/McShelby/hugo-theme-relearn/issues/310" target="_blank">#310</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="510-2022-07-15">5.1.0 (2022-07-15)</h2>
|
||
<h3 id="enhancements-36">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] print: make print url deterministic <a href="https://github.com/McShelby/hugo-theme-relearn/issues/309" target="_blank">#309</a></li>
|
||
<li>[<strong>feature</strong>] theme: allow overrid'n partials fer output formats <a href="https://github.com/McShelby/hugo-theme-relearn/issues/308" target="_blank">#308</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="503-2022-07-07">5.0.3 (2022-07-07)</h2>
|
||
<h3 id="fixes-64">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] ie11: no styles after rework o' archetypes <a href="https://github.com/McShelby/hugo-theme-relearn/issues/306" target="_blank">#306</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="502-2022-07-07">5.0.2 (2022-07-07)</h2>
|
||
<h3 id="fixes-65">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: board CSS if JS be disabled <a href="https://github.com/McShelby/hugo-theme-relearn/issues/305" target="_blank">#305</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="501-2022-07-07">5.0.1 (2022-07-07)</h2>
|
||
<h3 id="enhancements-37">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>break'n</strong>] theme: opt'mize load'n o' js an' css <a href="https://github.com/McShelby/hugo-theme-relearn/issues/303" target="_blank">#303</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="500-2022-07-05">5.0.0 (2022-07-05)</h2>
|
||
<h3 id="enhancements-38">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] archetypes: modularize render'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/300" target="_blank">#300</a></li>
|
||
<li>[<strong>feature</strong>] history: don’t reload plank when history gets cleared <a href="https://github.com/McShelby/hugo-theme-relearn/issues/299" target="_blank">#299</a></li>
|
||
<li>[<strong>feature</strong>] menu: replace expander by fontawesome chevrons <a href="https://github.com/McShelby/hugo-theme-relearn/issues/296" target="_blank">#296</a></li>
|
||
<li>[<strong>feature</strong>] theme: align rrrambl'n wit' topbar ay'con limits <a href="https://github.com/McShelby/hugo-theme-relearn/issues/290" target="_blank">#290</a></li>
|
||
<li>[<strong>feature</strong>] button: allow fer empty href <a href="https://github.com/McShelby/hugo-theme-relearn/issues/288" target="_blank">#288</a></li>
|
||
<li>[<strong>feature</strong>] i18n: make Simplified Chinese th' standard language fer th' <code>zn</code> code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/287" target="_blank">#287</a></li>
|
||
<li>[<strong>feature</strong>] clipboard: move head styles t' stylesheet <a href="https://github.com/McShelby/hugo-theme-relearn/issues/286" target="_blank">#286</a></li>
|
||
<li>[<strong>feature</strong>] math: add mathjax render'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/235" target="_blank">#235</a></li>
|
||
<li>[<strong>feature</strong>] theme: allow fer plank head'n modificat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/139" target="_blank">#139</a></li>
|
||
</ul>
|
||
<h3 id="fixes-66">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] favicon: fix URL if ship resides 'n subfolder <a href="https://github.com/McShelby/hugo-theme-relearn/issues/302" target="_blank">#302</a></li>
|
||
<li>[<strong>bug</strong>] code: show copy-to-clipboard marker fer blocklevel code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/298" target="_blank">#298</a></li>
|
||
<li>[<strong>bug</strong>] menu: make active expander vis'ble on hover <a href="https://github.com/McShelby/hugo-theme-relearn/issues/297" target="_blank">#297</a></li>
|
||
<li>[<strong>bug</strong>] print: dis'ble arrow navigat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/294" target="_blank">#294</a></li>
|
||
<li>[<strong>bug</strong>] print: add miss'n plank break after index or section <a href="https://github.com/McShelby/hugo-theme-relearn/issues/292" target="_blank">#292</a></li>
|
||
<li>[<strong>bug</strong>] theme: use more space on wide screens <a href="https://github.com/McShelby/hugo-theme-relearn/issues/291" target="_blank">#291</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix size o' chapter head'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/289" target="_blank">#289</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-12">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] chore: update RapiDoc 9.3.3 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/301" target="_blank">#301</a></li>
|
||
<li>[<strong>task</strong>] chore: update Merrrmaid 9.1.3 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/293" target="_blank">#293</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="425-2022-06-23">4.2.5 (2022-06-23)</h2>
|
||
<h3 id="fixes-67">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: javascript code does not board 'n documentat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/285" target="_blank">#285</a></li>
|
||
<li>[<strong>bug</strong>] children: descript'ns not work'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/284" target="_blank">#284</a></li>
|
||
<li>[<strong>bug</strong>] print: fix empty plank fer shortcut links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/283" target="_blank">#283</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="424-2022-06-23">4.2.4 (2022-06-23)</h2>
|
||
<h3 id="fixes-68">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix url fer logo an' home button <a href="https://github.com/McShelby/hugo-theme-relearn/issues/282" target="_blank">#282</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="423-2022-06-23">4.2.3 (2022-06-23)</h2>
|
||
<h3 id="fixes-69">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>break'n</strong>] include: second parameter be ignored <a href="https://github.com/McShelby/hugo-theme-relearn/issues/281" target="_blank">#281</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="422-2022-06-23">4.2.2 (2022-06-23)</h2>
|
||
<p><em>No changelog fer this release.</em></p>
|
||
<hr>
|
||
<h2 id="421-2022-06-23">4.2.1 (2022-06-23)</h2>
|
||
<p><em>No changelog fer this release.</em></p>
|
||
<hr>
|
||
<h2 id="420-2022-06-23">4.2.0 (2022-06-23)</h2>
|
||
<h3 id="enhancements-39">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] tabs: don’t change tab select'n if panel does not contain item <a href="https://github.com/McShelby/hugo-theme-relearn/issues/279" target="_blank">#279</a></li>
|
||
<li>[<strong>feature</strong>] shorrrtcodes: convert t' partials <a href="https://github.com/McShelby/hugo-theme-relearn/issues/277" target="_blank">#277</a></li>
|
||
</ul>
|
||
<h3 id="fixes-70">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: avoid builtin syntax-highlightn'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/280" target="_blank">#280</a></li>
|
||
<li>[<strong>bug</strong>] search: fix console message fer miss'n lunr translat'ns <a href="https://github.com/McShelby/hugo-theme-relearn/issues/278" target="_blank">#278</a></li>
|
||
<li>[<strong>bug</strong>] tabs: fix wrapp'n when hav'n many tabs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/272" target="_blank">#272</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="411-2022-06-18">4.1.1 (2022-06-18)</h2>
|
||
<h3 id="fixes-71">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] notice: fix layout when rrrambl'n starts wit' head'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/275" target="_blank">#275</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="410-2022-06-12">4.1.0 (2022-06-12)</h2>
|
||
<h3 id="enhancements-40">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: support multilang rrrambl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/271" target="_blank">#271</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="405-2022-06-12">4.0.5 (2022-06-12)</h2>
|
||
<h3 id="fixes-72">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] i18n: Vietnamese language wit' wrong lang code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/270" target="_blank">#270</a></li>
|
||
<li>[<strong>bug</strong>] i18n: fix search fer non western languages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/269" target="_blank">#269</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="404-2022-06-07">4.0.4 (2022-06-07)</h2>
|
||
<h3 id="enhancements-41">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: improve keyboard navigat'n fer scroll'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/268" target="_blank">#268</a></li>
|
||
</ul>
|
||
<h3 id="fixes-73">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: adjust font-size fer method buttons <a href="https://github.com/McShelby/hugo-theme-relearn/issues/267" target="_blank">#267</a></li>
|
||
<li>[<strong>bug</strong>] menu: hide expander when only hidden subpages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/264" target="_blank">#264</a></li>
|
||
<li>[<strong>bug</strong>] theme: make compat'ble wit' Cap'n Hugo 0.100.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/263" target="_blank">#263</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-13">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] swagger: update rapidoc t' 9.3.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/266" target="_blank">#266</a></li>
|
||
<li>[<strong>task</strong>] mermaid: update t' 9.1.1 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/265" target="_blank">#265</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="403-2022-06-05">4.0.3 (2022-06-05)</h2>
|
||
<h3 id="enhancements-42">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] toc: add scrollbar <a href="https://github.com/McShelby/hugo-theme-relearn/issues/262" target="_blank">#262</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="402-2022-06-05">4.0.2 (2022-06-05)</h2>
|
||
<h3 id="fixes-74">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: let browser scroll plank on CTRL+f <a href="https://github.com/McShelby/hugo-theme-relearn/issues/242" target="_blank">#242</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="401-2022-06-05">4.0.1 (2022-06-05)</h2>
|
||
<p><em>No changelog fer this release.</em></p>
|
||
<hr>
|
||
<h2 id="400-2022-06-05">4.0.0 (2022-06-05)</h2>
|
||
<h3 id="enhancements-43">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] shorrrtcodes: add named parameter if miss'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/260" target="_blank">#260</a></li>
|
||
<li>[<strong>feature</strong>][<strong>break'n</strong>] theme: remove –MAIN-ANCHOR-color from stylesheet <a href="https://github.com/McShelby/hugo-theme-relearn/issues/256" target="_blank">#256</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add Italian translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/254" target="_blank">#254</a></li>
|
||
<li>[<strong>feature</strong>] attachments: support fer brand colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/252" target="_blank">#252</a></li>
|
||
<li>[<strong>feature</strong>] notice: support fer brand colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/251" target="_blank">#251</a></li>
|
||
<li>[<strong>feature</strong>][<strong>break'n</strong>] config: remove custom_css <a href="https://github.com/McShelby/hugo-theme-relearn/issues/248" target="_blank">#248</a></li>
|
||
<li>[<strong>feature</strong>] theme: use proper file extension fer page-meta.go <a href="https://github.com/McShelby/hugo-theme-relearn/issues/246" target="_blank">#246</a></li>
|
||
<li>[<strong>feature</strong>] variant: add support fer brand color variables <a href="https://github.com/McShelby/hugo-theme-relearn/issues/239" target="_blank">#239</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add Polish translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/237" target="_blank">#237</a></li>
|
||
</ul>
|
||
<h3 id="fixes-75">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] shorrrtcodes: accept boolean parameters if given as str'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/261" target="_blank">#261</a></li>
|
||
<li>[<strong>bug</strong>] print: adjust button an' tab size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/259" target="_blank">#259</a></li>
|
||
<li>[<strong>bug</strong>] print: show Merrrmaid if requested 'n frontmatter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/255" target="_blank">#255</a></li>
|
||
<li>[<strong>bug</strong>] theme: adjust thin scrollbar slider <a href="https://github.com/McShelby/hugo-theme-relearn/issues/244" target="_blank">#244</a></li>
|
||
<li>[<strong>bug</strong>] mobile: fix broken scrollbar <a href="https://github.com/McShelby/hugo-theme-relearn/issues/243" target="_blank">#243</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix display o' tooltip fer head'n anchor <a href="https://github.com/McShelby/hugo-theme-relearn/issues/241" target="_blank">#241</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="341-2022-04-03">3.4.1 (2022-04-03)</h2>
|
||
<h3 id="fixes-76">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix IE11 incompatibilities <a href="https://github.com/McShelby/hugo-theme-relearn/issues/234" target="_blank">#234</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="340-2022-04-03">3.4.0 (2022-04-03)</h2>
|
||
<h3 id="enhancements-44">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Traditional Chinese translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/233" target="_blank">#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" target="_blank">#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" target="_blank">#230</a></li>
|
||
<li>[<strong>feature</strong>][<strong>break'n</strong>] theme: apply user supplied rrrambl'n footer below rrrambl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/229" target="_blank">#229</a></li>
|
||
</ul>
|
||
<h3 id="fixes-77">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" target="_blank">#232</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="330-2022-03-28">3.3.0 (2022-03-28)</h2>
|
||
<h3 id="enhancements-45">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: add CSS font variables <a href="https://github.com/McShelby/hugo-theme-relearn/issues/227" target="_blank">#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" target="_blank">#226</a></li>
|
||
</ul>
|
||
<h3 id="fixes-78">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" target="_blank">#228</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="321-2022-03-25">3.2.1 (2022-03-25)</h2>
|
||
<h3 id="fixes-79">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix minor inconsistencies <a href="https://github.com/McShelby/hugo-theme-relearn/issues/225" target="_blank">#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" target="_blank">#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" target="_blank">#223</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="320-2022-03-19">3.2.0 (2022-03-19)</h2>
|
||
<h3 id="enhancements-46">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] mermaid: support differ'n themes fer color variant switch <a href="https://github.com/McShelby/hugo-theme-relearn/issues/219" target="_blank">#219</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: board javascript on demand <a href="https://github.com/McShelby/hugo-theme-relearn/issues/218" target="_blank">#218</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-14">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update t' 8.14.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/220" target="_blank">#220</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="311-2022-03-16">3.1.1 (2022-03-16)</h2>
|
||
<h3 id="enhancements-47">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Korean translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/217" target="_blank">#217</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="310-2022-03-15">3.1.0 (2022-03-15)</h2>
|
||
<h3 id="enhancements-48">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] notice: add ay'con parameter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/212" target="_blank">#212</a></li>
|
||
<li>[<strong>feature</strong>] mobile: remove breadcrumb ellipsis <a href="https://github.com/McShelby/hugo-theme-relearn/issues/211" target="_blank">#211</a></li>
|
||
</ul>
|
||
<h3 id="fixes-80">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" target="_blank">#214</a></li>
|
||
<li>[<strong>bug</strong>] variant: switch breadcrumb color 'n Chrome <a href="https://github.com/McShelby/hugo-theme-relearn/issues/213" target="_blank">#213</a></li>
|
||
<li>[<strong>bug</strong>] mobile: improve behavior o' sidebar menu <a href="https://github.com/McShelby/hugo-theme-relearn/issues/210" target="_blank">#210</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="304-2022-02-24">3.0.4 (2022-02-24)</h2>
|
||
<h3 id="enhancements-49">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: improve font load'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/201" target="_blank">#201</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] variant: fix inconsistent color vari'ble nam'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/200" target="_blank">#200</a></li>
|
||
</ul>
|
||
<h3 id="fixes-81">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" target="_blank">#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" target="_blank">#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" target="_blank">#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" target="_blank">#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" target="_blank">#202</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="303-2022-02-23">3.0.3 (2022-02-23)</h2>
|
||
<h3 id="enhancements-50">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" target="_blank">#195</a></li>
|
||
</ul>
|
||
<h3 id="fixes-82">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" target="_blank">#197</a></li>
|
||
<li>[<strong>bug</strong>] tags: adhere t' titleSeparator <a href="https://github.com/McShelby/hugo-theme-relearn/issues/196" target="_blank">#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" target="_blank">#194</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="302-2022-02-23">3.0.2 (2022-02-23)</h2>
|
||
<h3 id="enhancements-51">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tags: sort by name <a href="https://github.com/McShelby/hugo-theme-relearn/issues/193" target="_blank">#193</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="301-2022-02-23">3.0.1 (2022-02-23)</h2>
|
||
<h3 id="enhancements-52">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" target="_blank">#192</a></li>
|
||
</ul>
|
||
<h3 id="fixes-83">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" target="_blank">#191</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="300-2022-02-22">3.0.0 (2022-02-22)</h2>
|
||
<h3 id="enhancements-53">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] variant: build a variant generator <a href="https://github.com/McShelby/hugo-theme-relearn/issues/188" target="_blank">#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" target="_blank">#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" target="_blank">#181</a></li>
|
||
<li>[<strong>feature</strong>] variant: add a variant selector <a href="https://github.com/McShelby/hugo-theme-relearn/issues/178" target="_blank">#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" target="_blank">#177</a></li>
|
||
<li>[<strong>feature</strong>] theme: support fer dark mode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/175" target="_blank">#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" target="_blank">#174</a></li>
|
||
<li>[<strong>feature</strong>] notice: tweak dull colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/173" target="_blank">#173</a></li>
|
||
<li>[<strong>feature</strong>] theme: rework header UX <a href="https://github.com/McShelby/hugo-theme-relearn/issues/151" target="_blank">#151</a></li>
|
||
</ul>
|
||
<h3 id="fixes-84">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" target="_blank">#190</a></li>
|
||
<li>[<strong>bug</strong>] clipboard: localize tooltips <a href="https://github.com/McShelby/hugo-theme-relearn/issues/186" target="_blank">#186</a></li>
|
||
<li>[<strong>bug</strong>] print: hide sidebar on Mac <a href="https://github.com/McShelby/hugo-theme-relearn/issues/183" target="_blank">#183</a></li>
|
||
<li>[<strong>bug</strong>] menu: fix scrollbar height <a href="https://github.com/McShelby/hugo-theme-relearn/issues/180" target="_blank">#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" target="_blank">#176</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="296-2022-02-07">2.9.6 (2022-02-07)</h2>
|
||
<h3 id="fixes-85">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: remove debug output <a href="https://github.com/McShelby/hugo-theme-relearn/issues/171" target="_blank">#171</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="295-2022-02-07">2.9.5 (2022-02-07)</h2>
|
||
<h3 id="fixes-86">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" target="_blank">#170</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="294-2022-02-06">2.9.4 (2022-02-06)</h2>
|
||
<h3 id="fixes-87">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" target="_blank">#168</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="293-2022-02-06">2.9.3 (2022-02-06)</h2>
|
||
<h3 id="fixes-88">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" target="_blank">#163</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="292-2021-11-26">2.9.2 (2021-11-26)</h2>
|
||
<h3 id="enhancements-54">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" target="_blank">#158</a></li>
|
||
</ul>
|
||
<h3 id="fixes-89">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" target="_blank">#160</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="291-2021-11-22">2.9.1 (2021-11-22)</h2>
|
||
<h3 id="fixes-90">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" target="_blank">#157</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="290-2021-11-19">2.9.0 (2021-11-19)</h2>
|
||
<h3 id="fixes-91">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" target="_blank">#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" target="_blank">#155</a></li>
|
||
<li>[<strong>bug</strong>] menu: align long text properly <a href="https://github.com/McShelby/hugo-theme-relearn/issues/154" target="_blank">#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" target="_blank">#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" target="_blank">#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" target="_blank">#149</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="283-2021-11-09">2.8.3 (2021-11-09)</h2>
|
||
<h3 id="fixes-92">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" target="_blank">#145</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: remove whitespace from big graphs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/143" target="_blank">#143</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="282-2021-11-08">2.8.2 (2021-11-08)</h2>
|
||
<h3 id="fixes-93">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" target="_blank">#142</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="281-2021-11-04">2.8.1 (2021-11-04)</h2>
|
||
<h3 id="fixes-94">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" target="_blank">#140</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="280-2021-11-03">2.8.0 (2021-11-03)</h2>
|
||
<h3 id="enhancements-55">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" target="_blank">#133</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: only board javascript if necessary <a href="https://github.com/McShelby/hugo-theme-relearn/issues/95" target="_blank">#95</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: switch font <a href="https://github.com/McShelby/hugo-theme-relearn/issues/83" target="_blank">#83</a></li>
|
||
<li>[<strong>feature</strong>] theme: make favicon configur'ble <a href="https://github.com/McShelby/hugo-theme-relearn/issues/2" target="_blank">#2</a></li>
|
||
</ul>
|
||
<h3 id="fixes-95">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" target="_blank">#136</a></li>
|
||
<li>[<strong>bug</strong>] menu: remove usage o' Hugos UniqueID <a href="https://github.com/McShelby/hugo-theme-relearn/issues/131" target="_blank">#131</a></li>
|
||
<li>[<strong>bug</strong>] theme: reduce margin fer children shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/130" target="_blank">#130</a></li>
|
||
<li>[<strong>bug</strong>] theme: left-align h3 'n chapters <a href="https://github.com/McShelby/hugo-theme-relearn/issues/129" target="_blank">#129</a></li>
|
||
<li>[<strong>bug</strong>] theme: align copy link t' clipboard <a href="https://github.com/McShelby/hugo-theme-relearn/issues/128" target="_blank">#128</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="270-2021-10-24">2.7.0 (2021-10-24)</h2>
|
||
<h3 id="enhancements-56">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] notice: support custom titles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/124" target="_blank">#124</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="260-2021-10-21">2.6.0 (2021-10-21)</h2>
|
||
<h3 id="fixes-96">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" target="_blank">#120</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="251-2021-10-12">2.5.1 (2021-10-12)</h2>
|
||
<h3 id="fixes-97">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" target="_blank">#117</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="250-2021-10-08">2.5.0 (2021-10-08)</h2>
|
||
<h3 id="enhancements-57">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" target="_blank">#113</a></li>
|
||
</ul>
|
||
<h3 id="fixes-98">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] security: fix XSS fer malicioius URLs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/114" target="_blank">#114</a></li>
|
||
<li>[<strong>bug</strong>] menu: write correct local shortcut links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/112" target="_blank">#112</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="241-2021-10-07">2.4.1 (2021-10-07)</h2>
|
||
<h3 id="fixes-99">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: remove runtime styles from print <a href="https://github.com/McShelby/hugo-theme-relearn/issues/111" target="_blank">#111</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="240-2021-10-07">2.4.0 (2021-10-07)</h2>
|
||
<h3 id="enhancements-58">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] lang: add vietnamese translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/109" target="_blank">#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" target="_blank">#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" target="_blank">#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" target="_blank">#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" target="_blank">#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" target="_blank">#97</a></li>
|
||
<li>[<strong>feature</strong>] theme: improve print style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/93" target="_blank">#93</a></li>
|
||
<li>[<strong>feature</strong>] theme: improve style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/92" target="_blank">#92</a></li>
|
||
</ul>
|
||
<h3 id="fixes-100">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" target="_blank">#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" target="_blank">#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" target="_blank">#82</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-15">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] chore: update fontawesome <a href="https://github.com/McShelby/hugo-theme-relearn/issues/94" target="_blank">#94</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="232-2021-09-20">2.3.2 (2021-09-20)</h2>
|
||
<h3 id="fixes-101">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] docs: rename history pirate translat'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/91" target="_blank">#91</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="231-2021-09-20">2.3.1 (2021-09-20)</h2>
|
||
<h3 id="fixes-102">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" target="_blank">#90</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="230-2021-09-13">2.3.0 (2021-09-13)</h2>
|
||
<h3 id="fixes-103">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix usage o' section element <a href="https://github.com/McShelby/hugo-theme-relearn/issues/88" target="_blank">#88</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-16">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] theme: ensure IE11 compatiblity <a href="https://github.com/McShelby/hugo-theme-relearn/issues/89" target="_blank">#89</a></li>
|
||
<li>[<strong>task</strong>] docs: Arrr! showcase multilang featurrre <a href="https://github.com/McShelby/hugo-theme-relearn/issues/87" target="_blank">#87</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="220-2021-09-09">2.2.0 (2021-09-09)</h2>
|
||
<h3 id="enhancements-59">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" target="_blank">#85</a></li>
|
||
</ul>
|
||
<h3 id="fixes-104">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" target="_blank">#86</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-17">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" target="_blank">#84</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="210-2021-09-07">2.1.0 (2021-09-07)</h2>
|
||
<h3 id="enhancements-60">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" target="_blank">#80</a></li>
|
||
<li>[<strong>feature</strong>] menu: scroll active item into view <a href="https://github.com/McShelby/hugo-theme-relearn/issues/79" target="_blank">#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" target="_blank">#76</a></li>
|
||
<li>[<strong>feature</strong>] search: improve readablility o' index.json <a href="https://github.com/McShelby/hugo-theme-relearn/issues/75" target="_blank">#75</a></li>
|
||
<li>[<strong>feature</strong>] search: increase performance <a href="https://github.com/McShelby/hugo-theme-relearn/issues/74" target="_blank">#74</a></li>
|
||
<li>[<strong>feature</strong>] search: improve search context preview <a href="https://github.com/McShelby/hugo-theme-relearn/issues/73" target="_blank">#73</a></li>
|
||
</ul>
|
||
<h3 id="fixes-105">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" target="_blank">#81</a></li>
|
||
<li>[<strong>bug</strong>] menu: always hide hidden sub planks <a href="https://github.com/McShelby/hugo-theme-relearn/issues/77" target="_blank">#77</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="200-2021-08-28">2.0.0 (2021-08-28)</h2>
|
||
<h3 id="enhancements-61">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tabs: enhance styl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/65" target="_blank">#65</a></li>
|
||
<li>[<strong>feature</strong>] theme: improve readability <a href="https://github.com/McShelby/hugo-theme-relearn/issues/64" target="_blank">#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" target="_blank">#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" target="_blank">#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" target="_blank">#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" target="_blank">#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" target="_blank">#55</a></li>
|
||
<li>[<strong>feature</strong>] children: add parameter fer container style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/53" target="_blank">#53</a></li>
|
||
<li>[<strong>feature</strong>] theme: make rrrambl'n a template <a href="https://github.com/McShelby/hugo-theme-relearn/issues/50" target="_blank">#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" target="_blank">#49</a></li>
|
||
<li>[<strong>feature</strong>] include: new shortcode t' include other files <a href="https://github.com/McShelby/hugo-theme-relearn/issues/43" target="_blank">#43</a></li>
|
||
<li>[<strong>feature</strong>] theme: adjust print styles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/35" target="_blank">#35</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] code highlighter: switch t' standard hugo highlighter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/32" target="_blank">#32</a></li>
|
||
</ul>
|
||
<h3 id="fixes-106">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" target="_blank">#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" target="_blank">#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" target="_blank">#61</a></li>
|
||
<li>[<strong>bug</strong>] theme: remove superfluous singular taxonomy from taxonomy title <a href="https://github.com/McShelby/hugo-theme-relearn/issues/46" target="_blank">#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" target="_blank">#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" target="_blank">#44</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-18">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] docs: include changelog 'n exampleSite <a href="https://github.com/McShelby/hugo-theme-relearn/issues/33" target="_blank">#33</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="120-2021-07-26">1.2.0 (2021-07-26)</h2>
|
||
<h3 id="enhancements-62">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: adjust copy-to-clipboard <a href="https://github.com/McShelby/hugo-theme-relearn/issues/29" target="_blank">#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" target="_blank">#28</a></li>
|
||
<li>[<strong>feature</strong>] theme: adjust blockquote contrast <a href="https://github.com/McShelby/hugo-theme-relearn/issues/27" target="_blank">#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" target="_blank">#25</a></li>
|
||
<li>[<strong>feature</strong>] expand: rework styl'n <a href="https://github.com/McShelby/hugo-theme-relearn/issues/24" target="_blank">#24</a></li>
|
||
<li>[<strong>feature</strong>] attachments: sort output <a href="https://github.com/McShelby/hugo-theme-relearn/issues/23" target="_blank">#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" target="_blank">#20</a></li>
|
||
<li>[<strong>feature</strong>] notice: fix contrast issues <a href="https://github.com/McShelby/hugo-theme-relearn/issues/19" target="_blank">#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" target="_blank">#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" target="_blank">#17</a></li>
|
||
</ul>
|
||
<h3 id="fixes-107">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: support i18n fer attachment size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/21" target="_blank">#21</a></li>
|
||
<li>[<strong>bug</strong>] notice: support i18n fer box labels <a href="https://github.com/McShelby/hugo-theme-relearn/issues/16" target="_blank">#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" target="_blank">#15</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-19">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" target="_blank">#30</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="111-2021-07-04">1.1.1 (2021-07-04)</h2>
|
||
<h3 id="maintenance-20">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" target="_blank">#13</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="110-2021-07-02">1.1.0 (2021-07-02)</h2>
|
||
<h3 id="enhancements-63">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" target="_blank">#4</a></li>
|
||
</ul>
|
||
<h3 id="fixes-108">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" target="_blank">#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" target="_blank">#10</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: support pan & zoom fer graphs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/9" target="_blank">#9</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: code fences not always rendered <a href="https://github.com/McShelby/hugo-theme-relearn/issues/6" target="_blank">#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" target="_blank">#5</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-21">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update t' 8.10.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/7" target="_blank">#7</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="101-2021-07-01">1.0.1 (2021-07-01)</h2>
|
||
<h3 id="maintenance-22">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] Prepare fer hugo showcase <a href="https://github.com/McShelby/hugo-theme-relearn/issues/3" target="_blank">#3</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="100-2021-07-01">1.0.0 (2021-07-01)</h2>
|
||
<h3 id="maintenance-23">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] Fork project <a href="https://github.com/McShelby/hugo-theme-relearn/issues/1" target="_blank">#1</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
<article class="chapter">
|
||
<header class="headline">
|
||
</header>
|
||
<div class="article-subheading">T' chapterrr 2</div>
|
||
<h1 id="rambln">Rambl'n</h1>
|
||
|
||
|
||
<p>Find out how t' create an' org'nize yer rrrambl'n quickly an' intuitively.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsct'ns o' Rambl'n</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="planks-orrrganizatn">planks orrrganizat'n</h1>
|
||
|
||
|
||
<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/" target="_blank">any other Cap'n Hugo project</a>. Typically, ye will have a <em>rrrambl'n</em> folder wit' all yer planks.</p>
|
||
<div class="wrap-code 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 cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></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="create-your-project">Create yer project</h2>
|
||
<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 <a href="https://gohugo.io/overview/quickstart/" target="_blank">great documentat'n fer beginners</a>.</p>
|
||
<p>Cap'n Hugo provides a <code>new</code> command t' create a new website.</p>
|
||
<div class="wrap-code 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="../cont/archetypes/index.html">archetypes</a> t' help ye create this kind o' planks.</p>
|
||
<h2 id="frontmatter-configuration">Frontmatter Configurat'n</h2>
|
||
<p>Each Cap'n Hugo plank has t' define a <a href="https://gohugo.io/content/front-matter/" target="_blank">frontmatter</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="wrap-code 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 t' true, th' menu 'n th' sidebar will be displayed 'n a collaps'ble tree view. Although th' functionality works wit' old browsers (IE11), th' display o' th' expander ay'cons be limited t' modern browsers</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><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">"weight"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">headingPre</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 head'n will be postfixed by this HTML rrrambl'n</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">headingPost</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 prefixed by this HTML rrrambl'n</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">menuPre</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">menuPost</span> <span class="p">=</span> <span class="s2">""</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="c"># Override default values fer image effects, ye can even add yer own arbitrary effects t' th' list</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">imageEffects</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">border</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</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>menuPre</code> param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.</p>
|
||
<div class="wrap-code 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">menuPre</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><a href="#R-image-33311f602dd84bde0b9c830be6b2a57b" class="lightbox-link"><img src="../cont/pages/frontmatter-icon.png?width=18.75rem" alt="Title wit' icon" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 18.75rem;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-33311f602dd84bde0b9c830be6b2a57b"><img src="../cont/pages/frontmatter-icon.png?width=18.75rem" alt="Title wit' icon" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></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/" target="_blank">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="wrap-code 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="wrap-code 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 recursively</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="../shortcodes/children/index.html">children shortcode</a> an' its children planks.</p>
|
||
<h2 id="disable-section-pages">Dis'ble Sect'n Planks</h2>
|
||
<p>Ye may want t' structure yer planks 'n a hierachical way but don’t want t' generate planks fer those sections? Th' theme got ye covered.</p>
|
||
<p>T' stay wit' th' initial example: Suppose ye want <code>level-one</code> appear 'n th' sidebar but don’t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should show an expander.</p>
|
||
<p>For this, open <code>content/level-one/_index.md</code> an' add th' follow'n frontmatter</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">collapsibleMenu</span> <span class="p">=</span> <span class="kc">true</span> <span class="c"># this adds th' expander t' th' menu entry if not already set 'n yer config.toml</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s2">"never"</span> <span class="c"># no plank will be generated so th' plank does not have a url</span></span></span></code></pre></div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="arrrchetypes">Arrrchetypes</h1>
|
||
|
||
|
||
<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/" target="_blank">archetypes</a>. These be preconfigured skeleton planks wit' default frontmatter.</p>
|
||
<p>Th' Relearrrn theme defines some few archetypes o' planks but ye be free t' define new ones t' yer lik'n. All can be used at any level o' th' documentat'n, th' only difference be'n th' layout o' th' rrrambl'n.</p>
|
||
<h2 id="predefined-archetypes">Predefined Archetypes</h2>
|
||
<h3 id="archetypes-home">Home</h3>
|
||
<p>A <strong>Home</strong> plank be th' start'n plank o' yer project. It’s best t' have only one plank o' this kind 'n yer project.</p>
|
||
<p><a href="#R-image-21e69a7bf5f69211ce4d280cdb6f946a" class="lightbox-link"><img src="../cont/archetypes/pages-home.png?width=60pc" alt="Home page" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 60pc;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-21e69a7bf5f69211ce4d280cdb6f946a"><img src="../cont/archetypes/pages-home.png?width=60pc" alt="Home page" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
<p>T' create a home plank, run th' follow'n command</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new --kind home _index.md</span></span></code></pre></div><p>This leads t' a file wit' th' follow'n rrrambl'n</p>
|
||
<div class="wrap-code 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">archetype = "home"
|
||
</span></span><span class="line"><span class="cl">title = "{{ replace .Name "-" " " | title }}"
|
||
</span></span><span class="line"><span class="cl">+++
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Lorem Ipsum.</span></span></code></pre></div><h3 id="archetypes-chapter">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 below it.</p>
|
||
<p><a href="#R-image-6eff0e14ac03471bac6fbd7f33b10cea" class="lightbox-link"><img src="../cont/archetypes/pages-chapter.png?width=60pc" alt="Chapter page" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 60pc;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-6eff0e14ac03471bac6fbd7f33b10cea"><img src="../cont/archetypes/pages-chapter.png?width=60pc" alt="Chapter page" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
<p>T' create a chapter plank, run th' follow'n command</p>
|
||
<div class="wrap-code 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>This leads t' a file wit' th' follow'n rrrambl'n</p>
|
||
<div class="wrap-code 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">archetype = "chapter"
|
||
</span></span><span class="line"><span class="cl">title = "{{ replace .Name "-" " " | title }}"
|
||
</span></span><span class="line"><span class="cl">weight = X
|
||
</span></span><span class="line"><span class="cl">+++
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Lorem Ipsum.</span></span></code></pre></div><p>Replace th' <code>X</code> wit' a number. Because this number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new chapter level.</p>
|
||
<h3 id="archetypes-default">Default</h3>
|
||
<p>A <strong>Default</strong> plank be any other rrrambl'n plank. If ye set an unknown archetype 'n yer frontmatter, this archetype will be used t' generate th' plank.</p>
|
||
<p><a href="#R-image-5498a632fe3dc4f963d5ec1ae3214b00" class="lightbox-link"><img src="../cont/archetypes/pages-default.png?width=60pc" alt="Default page" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 60pc;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-5498a632fe3dc4f963d5ec1ae3214b00"><img src="../cont/archetypes/pages-default.png?width=60pc" alt="Default page" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
<p>T' create a default plank, run either one o' th' follow'n commands</p>
|
||
<div class="wrap-code 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="wrap-code 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>This leads t' a file wit' th' follow'n rrrambl'n</p>
|
||
<div class="wrap-code 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">title = "{{ replace .Name "-" " " | title }}"
|
||
</span></span><span class="line"><span class="cl">weight = X
|
||
</span></span><span class="line"><span class="cl">+++
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Lorem Ipsum.</span></span></code></pre></div><p>Replace th' <code>X</code> wit' a number or delete th' whole <code>weight</code> parameter entirely.</p>
|
||
<h2 id="self-defined-archetypes">Self defined Archetypes</h2>
|
||
<p>If ye be 'n need o' further archetypes ye can define yer own or even redefine exist'n ones.</p>
|
||
<h3 id="template">Template</h3>
|
||
<p>Define a template file 'n yer project at <code>archetypes/<kind>.md</code> an' make sure it has at least th' frontmatter parameter fer that archetype like</p>
|
||
<div class="wrap-code 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">archetype = "<span class="p"><</span><span class="nt">kind</span><span class="p">></span>"
|
||
</span></span><span class="line"><span class="cl">+++</span></span></code></pre></div><p>Afterwards ye can generate new rrrambl'n files o' that kind wit' th' follow'n command</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new --kind <kind> <name>/_index.md</span></span></code></pre></div><h3 id="partials">Partials</h3>
|
||
<p>T' define how yer archetypes be rendered, define correspond'n partial files 'n yer projects directory <code>layouts/partials/archetypes/<kind></code>.</p>
|
||
<p>If ye use an unknown archetype 'n yer frontmatter, th' <code>default</code> archetype will be used t' generate th' plank.</p>
|
||
<p>Related t' each archetype, several <em>hook</em> partial files 'n th' form o' <code><hook>.html</code> can be given inside each archetype directory. If a partial fer a specific hook be miss'n, no output be generated fer this hook.</p>
|
||
<p>Th' follow'n hooks be used:</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>styleclass</td>
|
||
<td>Defines a set o' CSS classes t' be added t' th' HTML’s <code><main></code> element. Ye can use these classes t' define own CSS rules 'n yer <code>custom-header.html</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>article</td>
|
||
<td>Defines th' HTML how t' render yer rrrambl'n</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.</p>
|
||
<h4 id="output-formats">Output formats</h4>
|
||
<p>Each hook file can be overridden o' a specific <a href="https://gohugo.io/templates/output-formats/" target="_blank">output format</a>. Eg. if ye define a new output format <code>PLAINTEXT</code> 'n yer <code>config.toml</code>, ye can add a file <code>layouts/partials/archetypes/default.plaintext.html</code> t' change th' way how normal rrrambl'n be written fer that output format.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/content/index.html">Content</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="marrrkdown-rules">Marrrkdown rules</h1>
|
||
|
||
|
||
<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 HTML 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 cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Smarrrt Arrrse</div>
|
||
<div class="box-content">
|
||
|
||
<p><i class="fa-fw fas fa-bookmark"></i> Bookmark this plank an' th' <a href="https://commonmark.org/help/" target="_blank">official Commonmark reference</a> fer easy future reference!</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="paragraphs">Paragraphs</h2>
|
||
<p>In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.</p>
|
||
<p>Any text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.</p>
|
||
<div class="wrap-code 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.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">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>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.</p>
|
||
<p>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.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="headings">Head'ns</h2>
|
||
<p>A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from <code>h1</code> through <code>h6</code> be constructed wit' a <code>#</code> fer each level.</p>
|
||
<p>In Hugo ye usually don’t use <code>h1</code> as this be generated by yer theme an' ye should only have one such element 'n a document.</p>
|
||
<div class="wrap-code 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></span><span class="line"><span class="cl"><span class="gu">## h2 Head'n
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></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"></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"></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"></span>
|
||
</span></span><span class="line"><span class="cl">###### h6 Head'n</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<h1 id="h1-heading">h1 Head'n</h1>
|
||
<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>
|
||
</div>
|
||
</div>
|
||
<h2 id="horizontal-rules">Horizontal Rules</h2>
|
||
<p>T' further structure yer rrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes <code>---</code>.</p>
|
||
<div class="wrap-code 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.
|
||
</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">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>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.</p>
|
||
<hr>
|
||
<p>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.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="text-markers">Text Markers</h2>
|
||
<h3 id="bold">Bold</h3>
|
||
<p>Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks <code>**</code>.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">I am rendered wit' **bold text**</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>I am rendered wit' <strong>bold text</strong></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="italics">Italics</h3>
|
||
<p>Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores <code>_</code>.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">I am rendered wit' _italicized text_</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>I am rendered wit' <em>italicized text</em></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="strikethrough">Strikethrough</h3>
|
||
<p>In GFM (GitHub Flavored Markdown) ye can do strikethroughs by enclos'n text wit' two tildes <code>~~</code>.</p>
|
||
<div class="wrap-code 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>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><del>Strike through this text</del></p>
|
||
</div>
|
||
</div>
|
||
<h2 id="text-substitution">Text substitut'n</h2>
|
||
<p>This Marrrkdown dialect supports an extension t' combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Do'ble quotes <span class="sb">`"`</span> an' single quotes <span class="sb">`'`</span> o' enclosed text be replaced by <span class="ge">**</span>"do'ble curly quotes"** an' <span class="ge">**</span>'single curly quotes'**.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Do'ble dashes <span class="sb">`--`</span> an' triple dashes <span class="sb">`---`</span> be replaced by en-dash <span class="ge">**</span>--** an' em-dash <span class="ge">**</span>---** entities.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Do'ble arrows point'n left <span class="sb">`<<`</span> or right <span class="sb">`>>`</span> be replaced by arrow <span class="ge">**</span><span class="err"><<</span>** an' <span class="ge">**</span>>>** entities.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Three consecutive dots <span class="sb">`...`</span> be replaced by an ellipsis <span class="ge">**</span>...** entity.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>Do'ble quotes <code>"</code> an' single quotes <code>'</code> o' enclosed text be replaced by <strong>“do'ble curly quotes”</strong> an' <strong>‘single curly quotes’</strong>.</p>
|
||
<p>Do'ble dashes <code>--</code> an' triple dashes <code>---</code> be replaced by en-dash <strong>–</strong> an' em-dash <strong>—</strong> entities.</p>
|
||
<p>Do'ble arrows point'n left <code><<</code> or right <code>>></code> be replaced by arrow <strong>«</strong> an' <strong>»</strong> entities.</p>
|
||
<p>Three consecutive dots <code>...</code> be replaced by an ellipsis <strong>…</strong> entity.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="lists">Lists</h2>
|
||
<h3 id="unordered">Unordered</h3>
|
||
<p>Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.</p>
|
||
<p>It be poss'ble t' nest lists by indent'n an item fer th' next sublevel.</p>
|
||
<p>Ye may use any o' <code>-</code>, <code>*</code> or <code>+</code> t' denote bullets fer each list item but should not switch between those symbols inside one whole list.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">-</span> Lorem ipsum dolor sit amet
|
||
</span></span><span class="line"><span class="cl"><span class="k">-</span> Consectetur adipisc'n elit
|
||
</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"><span class="k">-</span> 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">- Faucibus porta lacus fringilla vel</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<ul>
|
||
<li>Lorem ipsum dolor sit amet</li>
|
||
<li>Consectetur adipisc'n elit
|
||
<ul>
|
||
<li>Vestibulum laoreet porttitor sem</li>
|
||
<li>Ac tristique libero volutpat at</li>
|
||
</ul>
|
||
</li>
|
||
<li>Nulla volutpat aliquam velit
|
||
<ul>
|
||
<li>Phasellus iaculis neque</li>
|
||
<li>Purus sodales ultricies</li>
|
||
</ul>
|
||
</li>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<h3 id="ordered">Ordered</h3>
|
||
<p>Ye can create a list o' items 'n which th' order o' items does explicitly matter.</p>
|
||
<p>It be poss'ble t' nest lists by indent'n an item fer th' next sublevel.</p>
|
||
<p>Marrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.</p>
|
||
<div class="wrap-code 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">3.</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">7.</span> Facilisis 'n pretium nisl aliquet
|
||
</span></span><span class="line"><span class="cl"><span class="k">99.</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">17. Eget porttitor lorem</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<ol>
|
||
<li>Lorem ipsum dolor sit amet</li>
|
||
<li>Consectetur adipisc'n elit
|
||
<ol>
|
||
<li>Integer molestie lorem at massa</li>
|
||
<li>Facilisis 'n pretium nisl aliquet</li>
|
||
</ol>
|
||
</li>
|
||
<li>Nulla volutpat aliquam velit
|
||
<ol>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
<li>Aenean sit amet erat nunc</li>
|
||
</ol>
|
||
</li>
|
||
<li>Eget porttitor lorem</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
<h3 id="tasks">Tasks</h3>
|
||
<p>In GFM (GitHub Flavored Markdown) ye can add task lists result'n 'n checked or unchecked non-click'ble items</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">- [x]</span> Basic Test
|
||
</span></span><span class="line"><span class="cl"><span class="k">- [ ]</span> More Tests
|
||
</span></span><span class="line"><span class="cl"> <span class="k">- [x]</span> View
|
||
</span></span><span class="line"><span class="cl"> <span class="k">- [x]</span> Hear
|
||
</span></span><span class="line"><span class="cl"> - [ ] Smell</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<ul>
|
||
<li><input checked="" disabled="" type="checkbox"> Basic Test</li>
|
||
<li><input disabled="" type="checkbox"> More Tests
|
||
<ul>
|
||
<li><input checked="" disabled="" type="checkbox"> View</li>
|
||
<li><input checked="" disabled="" type="checkbox"> Hear</li>
|
||
<li><input disabled="" type="checkbox"> Smell</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<h3 id="definitions">Definit'ns</h3>
|
||
<p>This Marrrkdown dialect supports an extension t' add definit'n lists. Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.</p>
|
||
<p>A definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.</p>
|
||
<p>If ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Apple
|
||
</span></span><span class="line"><span class="cl">: Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae.
|
||
</span></span><span class="line"><span class="cl">: An American computer company.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Orange
|
||
</span></span><span class="line"><span class="cl">: Th' fruit o' an evergreen tree o' th' genus Citrus.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> Ye can make juice out o' it.
|
||
</span></span><span class="line"><span class="cl">: A telecommunicat'n company.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> Ye can't make juice out o' it.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<dl>
|
||
<dt>Apple</dt>
|
||
<dd>Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae.</dd>
|
||
<dd>An American computer company.</dd>
|
||
<dt>Orange</dt>
|
||
<dd>Th' fruit o' an evergreen tree o' th' genus Citrus.
|
||
<p>Ye can make juice out o' it.</p>
|
||
</dd>
|
||
<dd>A telecommunicat'n company.
|
||
<p>Ye can’t make juice out o' it.</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</div>
|
||
<h2 id="code">Code</h2>
|
||
<h3 id="inline-code">Inline Code</h3>
|
||
<p>Inline snippets o' code can be wrapped wit' backticks <code>`</code>.</p>
|
||
<div class="wrap-code 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> be marked as code.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>In this example, <code><div></div></code> be marked as code.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="indented-code-block">Indented Code Block</h3>
|
||
<p>A simple code block can be generated by indent'n several lines o' code by at least two spaces.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Be impressed by my advanced code:
|
||
</span></span><span class="line"><span class="cl">
|
||
</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></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>Be impressed by my advanced code:</p>
|
||
<pre><code>// Some comments
|
||
line 1 o' code
|
||
line 2 o' code
|
||
line 3 o' code
|
||
</code></pre>
|
||
</div>
|
||
</div>
|
||
<h3 id="fenced-code-block">Fenced Code Block</h3>
|
||
<p>If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks <code>```</code> a so called fence.</p>
|
||
<p>In GFM (GitHub Flavored Markdown) ye can also add a language specifier directly after th' open'n fence, <code>```js</code>, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.</p>
|
||
<p>See <a href="../shortcodes/highlight/index.html">Code Highlight'n</a> fer additional documentat'n.</p>
|
||
<div class="wrap-code 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>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<div class="wrap-code 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></div>
|
||
</div>
|
||
<h2 id="tables">Tables</h2>
|
||
<p>In GFM (GitHub Flavored Markdown) ye can create tables 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="wrap-code 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>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<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>
|
||
</div>
|
||
</div>
|
||
<h3 id="aligned-columns">Aligned Columns</h3>
|
||
<p>Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">| Opt'n | Number | Descript'n |
|
||
</span></span><span class="line"><span class="cl">|-------:|:------:|:------------|
|
||
</span></span><span class="line"><span class="cl">| data | 1 | path t' data files t' supply th' data that will be passed into templates. |
|
||
</span></span><span class="line"><span class="cl">| engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. |
|
||
</span></span><span class="line"><span class="cl">| ext | 3 | extension t' be used fer dest files. |</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:right">Opt'n</th>
|
||
<th style="text-align:center">Number</th>
|
||
<th style="text-align:left">Descript'n</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:right">data</td>
|
||
<td style="text-align:center">1</td>
|
||
<td style="text-align:left">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:center">2</td>
|
||
<td style="text-align:left">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:center">3</td>
|
||
<td style="text-align:left">extension t' be used fer dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<h2 id="blockquotes">Blockquotes</h2>
|
||
<p>For quot'n blocks o' rrrambl'n from another source within yer document add <code>></code> before any text ye want t' quote.</p>
|
||
<p>Blockquotes can also be nested.</p>
|
||
<div class="wrap-code 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></span><span class="line"><span class="cl">> 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></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<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>
|
||
</div>
|
||
</div>
|
||
<h2 id="links">Links</h2>
|
||
<h3 id="autolink">Autolink</h3>
|
||
<p>In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">This be a link t' https://example.com.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>This be a link t' <a href="https://example.com" target="_blank">https://example.com</a>.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="basic-link">Basic Link</h3>
|
||
<p>Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.</p>
|
||
<div class="wrap-code 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>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="http://assemble.io" target="_blank">Assemble</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="link-with-tooltip">Link wit' Tooltip</h3>
|
||
<p>For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.</p>
|
||
<div class="wrap-code 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>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="https://github.com/upstage/" title="Visit Upstage!" target="_blank">Upstage</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="link-references">Link References</h3>
|
||
<p>Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">[Example][somelinkID]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[somelinkID]: https://example.com "Go t' example domain"</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="https://example.com" title="Go t' example domain" target="_blank">Example</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="footnotes">Footnotes</h3>
|
||
<p>Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.</p>
|
||
<p>Usually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.</p>
|
||
<p>Footnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">That's some text wit' a footnote[^1]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[^1]: An' that's th' footnote.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">That's some more text wit' a footnote.[^someid]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[^someid]:
|
||
</span></span><span class="line"><span class="cl"> Anyth'n o' interest goes here.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> Blue light glows blue.</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>That’s some text wit' a footnote<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></p>
|
||
<p>That’s some more text wit' a footnote.<sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup></p>
|
||
<div class="footnotes" role="doc-endnotes">
|
||
<hr>
|
||
<ol>
|
||
<li id="fn:1">
|
||
<p>An' that’s th' footnote. <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
<li id="fn:2">
|
||
<p>Anyth'n o' interest goes here.</p>
|
||
<p>Blue light glows blue. <a href="#fnref:2" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="images">Images</h2>
|
||
<h3 id="basic-images">Basic Images</h3>
|
||
<p>Images have a similar rules t' links but include a preced'n exclamat'n mark.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Spock</span>](<span class="na">https://octodex.github.com/images/spocktocat.png</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-07d3404e868b6c305a4a08a12a362dc9" class="lightbox-link"><img src="https://octodex.github.com/images/spocktocat.png?width=20vw" alt="Spock" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-07d3404e868b6c305a4a08a12a362dc9"><img src="https://octodex.github.com/images/spocktocat.png?width=20vw" alt="Spock" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="image-with-tooltip">Image wit' Tooltip</h3>
|
||
<p>Like links, images can also be given a tooltip.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Picard</span>](<span class="na">https://octodex.github.com/images/jean-luc-picat.jpg "Jean Luc Picard"</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-452ed3eca5eb0f7d54d2946a1cc510ff" class="lightbox-link"><img src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt="Picard" title="Jean Luc Picard" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-452ed3eca5eb0f7d54d2946a1cc510ff"><img src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt="Picard" title="Jean Luc Picard" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="image-references">Image References</h3>
|
||
<p>Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![La Forge][laforge]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[laforge]: https://octodex.github.com/images/trekkie.jpg "Geordi La Forge"</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-9df7c7a5ed9ef82e979e94e4b7f3606e" class="lightbox-link"><img src="https://octodex.github.com/images/trekkie.jpg?width=20vw" alt="La Forge" title="Geordi La Forge" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-9df7c7a5ed9ef82e979e94e4b7f3606e"><img src="https://octodex.github.com/images/trekkie.jpg?width=20vw" alt="La Forge" title="Geordi La Forge" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="image-effects">Image Effects</h3>
|
||
<p>This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. Th' default <a href="../cont/imageeffects/index.html">behavior be configur'ble</a> thru yer <code>config.toml</code> or frontmatter parameter.</p>
|
||
<h4 id="resizing">Resiz'n</h4>
|
||
<p>Add query parameter <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="wrap-code 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=20vw</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-4e0e350a1889c7b4ac4e4fa899de9714" class="lightbox-link"><img src="https://octodex.github.com/images/minion.png?width=20vw" alt="Minion" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-4e0e350a1889c7b4ac4e4fa899de9714"><img src="https://octodex.github.com/images/minion.png?width=20vw" alt="Minion" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<div class="wrap-code 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>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-eae699cde54a335e87fbbbf0c3ccfd08" class="lightbox-link"><img src="https://octodex.github.com/images/minion.png?height=50px" alt="Minion" class="figure-image bg-white border lightbox noshadow" style="height: 50px; width: auto;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-eae699cde54a335e87fbbbf0c3ccfd08"><img src="https://octodex.github.com/images/minion.png?height=50px" alt="Minion" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<div class="wrap-code 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=40vw</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-488004340d1ac6043d19e0ccac643564" class="lightbox-link"><img src="https://octodex.github.com/images/minion.png?height=50px&width=40vw" alt="Minion" class="figure-image bg-white border lightbox noshadow" style="height: 50px; width: 40vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-488004340d1ac6043d19e0ccac643564"><img src="https://octodex.github.com/images/minion.png?height=50px&width=40vw" alt="Minion" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<h4 id="css-classes">CSS Classes</h4>
|
||
<p>Add a query parameter <code>classes</code> t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.</p>
|
||
<h5 id="shadow">Shadow</h5>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Spidertocat</span>](<span class="na">https://octodex.github.com/images/spidertocat.png?classes=shadow</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-6704e4033b6c70f699e5e44c8dabb038" class="lightbox-link"><img src="https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder" alt="Spidertocat" class="figure-image bg-white border lightbox noborder shadow" style="height: auto; width: 20vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-6704e4033b6c70f699e5e44c8dabb038"><img src="https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder" alt="Spidertocat" class="lightbox-image bg-white border lightbox noborder shadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="border">Border</h5>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">DrOctocat</span>](<span class="na">https://octodex.github.com/images/droctocat.png?classes=border</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-65df649f3dc2b551d53045ec22c100f6" class="lightbox-link"><img src="https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow" alt="DrOctocat" class="figure-image bg-white border lightbox noshadow noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-65df649f3dc2b551d53045ec22c100f6"><img src="https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow" alt="DrOctocat" class="lightbox-image bg-white border lightbox noshadow noshadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="left">Left</h5>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Supertocat</span>](<span class="na">https://octodex.github.com/images/okal-eltocat.jpg?classes=left</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-006e7474ce5b3c996ab980795256a328" class="lightbox-link"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" alt="Supertocat" class="figure-image bg-white border left lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-006e7474ce5b3c996ab980795256a328"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" alt="Supertocat" class="lightbox-image bg-white border left lightbox noshadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="right">Right</h5>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Riddlocat</span>](<span class="na">https://octodex.github.com/images/riddlocat.jpg?classes=right</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-1311279f0439cdf18b902c7370c27652" class="lightbox-link"><img src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt="Riddlocat" class="figure-image bg-white border lightbox right noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-1311279f0439cdf18b902c7370c27652"><img src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt="Riddlocat" class="lightbox-image bg-white border lightbox right noshadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="inline">Inline</h5>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Spidertocat</span>](<span class="na">https://octodex.github.com/images/spidertocat.png?classes=inline</span>)
|
||
</span></span><span class="line"><span class="cl">![<span class="nt">DrOctocat</span>](<span class="na">https://octodex.github.com/images/droctocat.png?classes=inline</span>)
|
||
</span></span><span class="line"><span class="cl">![<span class="nt">Supertocat</span>](<span class="na">https://octodex.github.com/images/okal-eltocat.jpg?classes=inline</span>)
|
||
</span></span><span class="line"><span class="cl">![<span class="nt">Riddlocat</span>](<span class="na">https://octodex.github.com/images/riddlocat.jpg?classes=inline</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-2b670fee8ad758e155f07b65d0239188" class="lightbox-link"><img src="https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline" alt="Spidertocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-2b670fee8ad758e155f07b65d0239188"><img src="https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline" alt="Spidertocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a>
|
||
<a href="#R-image-2c7d3981b7427033e3abf53820174eb8" class="lightbox-link"><img src="https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt="DrOctocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-2c7d3981b7427033e3abf53820174eb8"><img src="https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt="DrOctocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a>
|
||
<a href="#R-image-07411fe5b4c63f9a21a337ff09138b38" class="lightbox-link"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" alt="Supertocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-07411fe5b4c63f9a21a337ff09138b38"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" alt="Supertocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a>
|
||
<a href="#R-image-033460dffa0b1835dbd935313e00fec1" class="lightbox-link"><img src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt="Riddlocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-033460dffa0b1835dbd935313e00fec1"><img src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt="Riddlocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="combination">Combinat'n</h5>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">X-tocat</span>](<span class="na">https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><a href="#R-image-ae75eba901a9f56c1d7ffd7211ba02ba" class="lightbox-link"><img src="https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" alt="X-tocat" class="figure-image bg-white border left lightbox shadow" style="height: auto; width: 20vw;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-ae75eba901a9f56c1d7ffd7211ba02ba"><img src="https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" alt="X-tocat" class="lightbox-image bg-white border left lightbox shadow" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
<h4 id="lightbox">Lightbox</h4>
|
||
<p>Add th' query parameter <code>lightbox=false</code> t' th' image link t' dis'ble th' lightbox.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![<span class="nt">Homercat</span>](<span class="na">https://octodex.github.com/images/homercat.png?lightbox=false</span>)</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p><img src="https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" alt="Homercat" class="figure-image bg-white border nolightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>If ye want t' wrap an image 'n a link an' <code>lightbox=true</code> be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">[<span class="nt">![Homercat</span>](<span class="na">https://octodex.github.com/images/homercat.png?lightbox=false</span>)](https://octodex.github.com/#homercat)</span></span></code></pre></div><p><a href="https://octodex.github.com/#homercat" target="_blank"><img src="https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" alt="Homercat" class="figure-image bg-white border nolightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="image-effects">Image Effects</h1>
|
||
|
||
|
||
<p>Th' theme supports non-standard <a href="../cont/markdown/index.html#image-effects">image effects</a>.</p>
|
||
<p>As described, ye can add this t' th' URL query parameter, but this may be cumbersome t' do it consistently fer th' whole plank.</p>
|
||
<p>Instead, ye can configure th' defaults 'n yer <code>config.toml</code> aswell as overrid'n these default 'n th' planks frontmatter.</p>
|
||
<p>Explicitly set URL query parameter will override th' defaults 'n effect fer a plank.</p>
|
||
<p>Without any sett'ns 'n yer <code>config.toml</code> this defaults t'</p>
|
||
|
||
|
||
<div class="tab-panel" data-tab-group="c598718fff2a9fde67c0dab15563e69f">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="configtoml"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('c598718fff2a9fde67c0dab15563e69f','configtoml')"
|
||
>
|
||
<span class="tab-nav-text">config.toml</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="configtoml"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">imageEffects</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">border</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><p>This can be overridden 'n a planks frontmatter by eg.</p>
|
||
|
||
|
||
<div class="tab-panel" data-tab-group="a02eafb8846eede86494f163f64f2d8b">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="frontmatter"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('a02eafb8846eede86494f163f64f2d8b','frontmatter')"
|
||
>
|
||
<span class="tab-nav-text">frontmatter</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="frontmatter"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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="p">[</span><span class="nx">imageEffects</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><p>Or by explicitly override sett'ns by URL query parameter</p>
|
||
|
||
|
||
<div class="tab-panel" data-tab-group="528b77b20409583fd067c7c7e552f864">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="url"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('528b77b20409583fd067c7c7e552f864','url')"
|
||
>
|
||
<span class="tab-nav-text">URL</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="url"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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?lightbox=false&bg-white=true</span>)</span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><p>Th' sett'ns applied t' th' above image would be</p>
|
||
|
||
|
||
<div class="tab-panel" data-tab-group="e1a7cbff80cee10fb0e5dff2494556ca">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="result"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('e1a7cbff80cee10fb0e5dff2494556ca','result')"
|
||
>
|
||
<span class="tab-nav-text">Result</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="result"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"> <span class="nx">border</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lightbox</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">shadow</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">bg-white</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><p>This ends up 'n th' follow'n HTML whar' th' parameter be converted t' CSS classes.</p>
|
||
|
||
|
||
<div class="tab-panel" data-tab-group="9b585c43968510cf60f89bd096e3a731">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="html"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('9b585c43968510cf60f89bd096e3a731','html')"
|
||
>
|
||
<span class="tab-nav-text">HTML</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="html"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">img</span> <span class="na">src</span><span class="o">=</span><span class="s">"https://octodex.github.com/images/minion.png?lightbox=false&bg-white=true"</span> <span class="na">alt</span><span class="o">=</span><span class="s">"Minion"</span> <span class="na">class</span><span class="o">=</span><span class="s">"bg-white border nolightbox noshadow"</span><span class="p">></span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div><h2 id="extending">Extend'n</h2>
|
||
<p>As ye can see 'n th' above example, th' <code>bg-white</code> parameter be not initially supported 'n th' themes default sett'ns. Nevertheless ye be free t' define arbitrary parameter by just add'n them t' th' URL query parameter or set them 'n yer <code>config.toml</code> or planks frontmatter.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>If no extended parameter like <code>bg-white</code> 'n th' example be set on th' URL, a <code>class="nobg-white"</code> 'n th' HTML will only be generated if a default value was set 'n th' <code>config.toml</code> or planks frontmatter.</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="menu-extrrra-shorrrtcuts">Menu extrrra shorrrtcuts</h1>
|
||
|
||
|
||
<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="wrap-code 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">"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 overridden 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="wrap-code 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/" target="_blank">hugo menu</a> an' <a href="https://gohugo.io/content-management/multilingual/#translation-of-strings" target="_blank">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="wrap-code 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="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">params</span><span class="p">]</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">pageRef</span> <span class="p">=</span> <span class="s2">"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">pageRef</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">pageRef</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="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">params</span><span class="p">]</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">pageRef</span> <span class="p">=</span> <span class="s2">"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">pageRef</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">pageRef</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/" target="_blank">hugo menu</a> an' <a href="https://gohugo.io/content-management/multilingual/#menus" target="_blank">hugo multilingual menus</a></p>
|
||
<h2 id="shortcuts-to-pages-inside-of-your-project">Shortcuts t' planks inside o' yer project</h2>
|
||
<p>If ye have shortcuts t' planks inside o' yer project an' ye don’t want them t' show up 'n plank menu section, ye have two choices:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Make th' plank file fer th' shortcut a <a href="https://gohugo.io/content-management/page-bundles/#headless-bundle" target="_blank">headless branch bundle</a> (contained 'n its own subdirectory an' called <code>_index.md</code>) an' add th' follow'n frontmatter configurat'n t' th' file (see exampleSite’s <code>content/showcase/_index.en.md</code>). This causes its rrrambl'n t' <strong>not</strong> be ontained 'n th' sitemap.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Showcase"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s2">"always"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">list</span> <span class="p">=</span> <span class="s2">"never"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">publishResources</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div></li>
|
||
<li>
|
||
<p>Store th' plank file fer th' shortcut below a parent headless branch bundle an' add th' follow'n frontmatter t' he <strong>parent</strong> (see exampleSite’s <code>content/more/_index.en.md</code>).</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="c"># title = "More" ### ATTENTION: Don't give this plank a title as this will cause it t' be 'n th' breadcrumbs - a th'n ye most likely don't want</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s2">"never"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">list</span> <span class="p">=</span> <span class="s2">"never"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">publishResources</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div><p>In this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see exampleSite’s <code>content/more/credits.en.md</code>). This causes its rrrambl'n t' be contained 'n th' sitemap.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Credits"</span></span></span></code></pre></div></li>
|
||
</ol>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="multilingual-an-i18n">Multilingual an' i18n</h1>
|
||
|
||
|
||
<p>Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.</p>
|
||
<ul>
|
||
<li>Avail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free t' contribute!</li>
|
||
<li>Full support fer languages written right t' left</li>
|
||
<li>Automatic menu generat'n from multilingual rrrambl'n</li>
|
||
<li>In-browser language switch'n</li>
|
||
</ul>
|
||
<p><a href="#R-image-8fb8b1109a97e8159a9d506d1732ece9" class="lightbox-link"><img src="../cont/i18n/i18n-menu.gif?width=18.75rem" alt="I18n menu" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 18.75rem;" loading="lazy"></a>
|
||
<a href="javascript:history.back();" class="lightbox-back" id="R-image-8fb8b1109a97e8159a9d506d1732ece9"><img src="../cont/i18n/i18n-menu.gif?width=18.75rem" alt="I18n menu" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
|
||
<h2 id="basic-configuration">Basic configurat'n</h2>
|
||
<p>Aft learn'n <a href="https://gohugo.io/content-management/multilingual" target="_blank">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="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>Make sure yer default language be defined as th' first one 'n th' <code>[languages]</code> array, as th' theme needs t' make assumpt'ns on it</p>
|
||
</div>
|
||
</div>
|
||
<div class="wrap-code 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 cstyle info">
|
||
<div class="box-label"><i class="fa-fw fas fa-info-circle"></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 cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Smarrrt Arrrse</div>
|
||
<div class="box-content">
|
||
|
||
<p>Use <a href="https://gohugo.io/content-management/multilingual/#translate-your-content" target="_blank">slug</a> frontmatter parameter t' translate urls too.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="search">Search</h2>
|
||
<p>In case each page’s rrrambl'n be written 'n one single language only, th' above configurat'n will already configure th' site’s search functionality correctly.</p>
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Arrr</div>
|
||
<div class="box-content">
|
||
|
||
<p>Although th' theme supports a wide variety o' supported languages, th' site’s search via th' <a href="https://lunrjs.com" target="_blank">Lunr</a> search library does not.
|
||
You’ll see error reports 'n yer browsers console log fer each unsupported language. Currently unsupported be:</p>
|
||
<ul>
|
||
<li>Czech</li>
|
||
<li>Indonesian</li>
|
||
<li>Polish</li>
|
||
<li>Swahili</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<h3 id="search-with-mixed-language-support">Search wit' mixed language support</h3>
|
||
<p>In case yer page’s rrrambl'n contains text 'n multiple languages (e.g. ye be writ'n a Russian documentat'n fer yer english API), ye can add those languages t' yer <code>config.toml</code> t' broaden search.</p>
|
||
<div class="wrap-code 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">additionalContentLanguage</span> <span class="p">=</span> <span class="p">[</span> <span class="s2">"en"</span> <span class="p">]</span></span></span></code></pre></div><p>As this be an array, ye can add multiple additional languages.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>Keep 'n mind that th' language code required here, be th' base language code. E.g. if ye have additional rrrambl'n 'n <code>zh-CN</code>, ye have t' add just <code>zh</code> t' this parameter.</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="wrap-code 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 multilingual 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 class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/tutorrrial/index.html">tutorrrial</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="taxonomy">Taxonomy</h1>
|
||
|
||
|
||
<p>Th' Relearrrn theme supports Hugo’s default taxonomies <em>tag</em> an' <em>category</em> out o' th' box.</p>
|
||
<h2 id="configuration">Configurat'n</h2>
|
||
<p>Just add tags and/or categories t' any plank. They can be given as a single str'n or an array o' str'ns.</p>
|
||
<div class="wrap-code 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">categories</span> <span class="p">=</span> <span class="p">[</span><span class="s2">"taxonomy"</span><span class="p">,</span> <span class="s2">"content"</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">tags</span> <span class="p">=</span> <span class="s2">"tutorial"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span> <span class="p">=</span> <span class="s2">"Taxonomy"</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 alphabetical order.</p>
|
||
<p>Th' categories be displayed at th' bottom o' th' plank 'n alphabetical order 'n th' default implementat'n o' th' theme but can be customized by provid'n yer own <code>content-footer.html</code> partial.</p>
|
||
<p>Each item be a link t' a taxonomy plank display'n all th' articles wit' th' given term.</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 an' categories</p>
|
||
<div class="wrap-code 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></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-layer-group'></i> Categories"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">url</span> <span class="p">=</span> <span class="s2">"/categories"</span></span></span></code></pre></div><h2 id="customization">Customizat'n</h2>
|
||
<p>If ye define <a href="https://gohugo.io/content-management/taxonomies/#configure-taxonomies" target="_blank">custom taxonomies</a> an' want t' display a list o' them somewhere on yer plank (often 'n th' <code>layouts/partials/content-footer.html</code>) ye can call a partial that does th' job fer ye:</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">{{- partial "term-list.html" (dict
|
||
</span></span><span class="line"><span class="cl"> "page" .
|
||
</span></span><span class="line"><span class="cl"> "taxonomy" "categories"
|
||
</span></span><span class="line"><span class="cl"> "icon" "layer-group"
|
||
</span></span><span class="line"><span class="cl">) }}</span></span></code></pre></div><h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>plank</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Mandatory reference t' th' plank.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>taxonomy</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Th' plural name o' th' taxonomy t' display as used 'n yer frontmatter.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>class</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Additional CSS classes set on th' outermost generated HTML element.<br><br>If set t' <code>tags</code> ye will get th' visuals fer display'n th' <em>tags</em> taxonomy, otherwise it will be a simple list o' links as fer th' <em>categories</em> taxonomy.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><code>primary</code></td>
|
||
<td>Th' style scheme used if <strong>class</strong> be <code>tags</code>.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td>see notes</td>
|
||
<td>Th' <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> t' be used if <strong>class</strong> be <code>tags</code>. If not set, th' chosen color depends on th' <strong>style</strong>. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n color fer th' severity<br>- fer all other styles: th' correspond'n color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>ay'con</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>An optional <a href="../shortcodes/icon/index.html#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' list.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
|
||
<footer class="footline">
|
||
<div class=" taxonomy-categories term-list cstyle " title="Categories" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<i class="fa-fw fas fa-layer-group"></i>
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/categories/content/index.html">content</a></li>
|
||
<li><a class="term-link" href="../pir/categories/taxonomy/index.html">taxonomy</a></li>
|
||
</ul>
|
||
</div>
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
<article class="chapter">
|
||
<header class="headline">
|
||
</header>
|
||
<div class="article-subheading">T' chapterrr 3</div>
|
||
<h1 id="shorrrtcodes">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/" target="_blank">shorrrtcodes</a>. A shortcode 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="../shortcodes/attachments/index.html">Attachments</a></h2><p>List o' files attached t' a plank</p>
|
||
<h2><a href="../shortcodes/badge/index.html">Badge</a></h2><p>Marker badges t' display 'n yer text</p>
|
||
<h2><a href="../shortcodes/button/index.html">Button</a></h2><p>Click'ble buttons</p>
|
||
<h2><a href="../shortcodes/children/index.html">Children</a></h2><p>List th' child planks o' a plank</p>
|
||
<h2><a href="../shortcodes/expand/index.html">Expand</a></h2><p>Expandable/collaps'ble sections o' text</p>
|
||
<h2><a href="../shortcodes/highlight/index.html">Highlight</a></h2><p>Render code wit' a rules highlighter</p>
|
||
<h2><a href="../shortcodes/icon/index.html">Ay'con</a></h2><p>Nice ay'cons fer yer plank</p>
|
||
<h2><a href="../shortcodes/include/index.html">Include</a></h2><p>Displays rrrambl'n from other files</p>
|
||
<h2><a href="../shortcodes/math/index.html">Math</a></h2><p>Beautiful math an' chemical formulae</p>
|
||
<h2><a href="../shortcodes/mermaid/index.html">Merrrmaid</a></h2><p>Generate diagrams an' flowcharts from text</p>
|
||
<h2><a href="../shortcodes/notice/index.html">Notice</a></h2><p>Disclaimers t' help ye structure yer plank</p>
|
||
<h2><a href="../shortcodes/openapi/index.html">OpenAPI</a></h2><p>UI fer yer OpenAPI / Swagger specificat'ns</p>
|
||
<h2><a href="../shortcodes/siteparam/index.html">SiteParam</a></h2><p>Get value o' ship params</p>
|
||
<h2><a href="../shortcodes/tab/index.html">Tab</a></h2><p>Show rrrambl'n 'n a single tab</p>
|
||
<h2><a href="../shortcodes/tabs/index.html">Tabs</a></h2><p>Show rrrambl'n 'n tabbed views</p>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsct'ns o' Shorrrtcodes</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="attachments">Attachments</h1>
|
||
|
||
|
||
<div class="box attachments cstyle transparent">
|
||
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="../pir/shortcodes/attachments/index.pir.files/NoTreasure.txt">NoTreasure.txt</a> (26 B)</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<p>Th' <code>attachments</code> shortcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.</p>
|
||
|
||
<div class="box attachments cstyle transparent">
|
||
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="../shortcodes/attachments/index.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/hugo.png">hugo.png</a> (17 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Arrr</div>
|
||
<div class="box-content">
|
||
|
||
<p>Since Cap'n Hugo <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.112.0</span></span> this only works fer leaf bundles. Branch bundles an' simple planks must be switched t' leaf bundles or ye be currently locked t' a Cap'n Hugo version < <code>0.112.0</code>.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">attachments</span> <span class="nx">sort</span><span class="p">=</span><span class="s">"asc"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/attachments.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"sort"</span> <span class="s">"asc"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><code>transparent</code></td>
|
||
<td>Th' style scheme used fer th' box.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td>see notes</td>
|
||
<td>Th' <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> t' be used. If not set, th' chosen color depends on th' <strong>style</strong>. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n color fer th' severity<br>- fer all other styles: th' correspond'n color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td>see notes</td>
|
||
<td>Arbitrary text fer th' box title. Depend'n on th' <strong>style</strong> there may be a default title. Any given value will overwrite th' default.<br><br>- fer severity styles: th' match'n title fer th' severity<br>- fer all other styles: <code>Attachments</code><br><br>If ye want no title fer a severity style, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>ay'con</strong></td>
|
||
<td>see notes</td>
|
||
<td><a href="../shortcodes/icon/index.html#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' title. Depend'n on th' <strong>style</strong> there may be a default ay'con. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n ay'con fer th' severity<br>- fer all other styles: <code>paperclip</code><br><br>If ye want no ay'con, ye have t' set this parameter t' <code>" "</code> (a non empty d wit' spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>sort</strong></td>
|
||
<td><code>asc</code></td>
|
||
<td>Sort'n th' output 'n <code>asc</code>end'n or <code>desc</code>end'n order.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>pattern</strong></td>
|
||
<td><code>.*</code></td>
|
||
<td>A <a href="https://en.wikipedia.org/wiki/Regular_expression" target="_blank">regular expressions</a>, used t' filter th' attachments by file name. For example:<br><br>- t' match a file suffix o' ‘jpg’, use <code>.*\.jpg</code> (not <code>*.\.jpg</code>)<br>- t' match file names end'n 'n <code>jpg</code> or <code>png</code>, use <code>.*\.(jpg|png)</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="setup">Setup</h2>
|
||
<h3 id="single-language">Single language</h3>
|
||
<p>Th' shortcode lists files found 'n a specific folder. Th' name o' th' folder depends on yer plank type (either branch bundle, leaf bundle or page).</p>
|
||
<ol>
|
||
<li>
|
||
<p>If yer plank be a leaf bundle, attachments must be placed 'n a nested <code>index.files</code> folder, accordingly.</p>
|
||
<blockquote>
|
||
<ul>
|
||
<li>rrrambl'n
|
||
<ul>
|
||
<li>_index.md</li>
|
||
<li>plank
|
||
<ul>
|
||
<li>_index.md</li>
|
||
<li><strong>_index.files</strong>
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</blockquote>
|
||
</li>
|
||
<li>
|
||
<p>If yer plank be a branch bundle, attachments must be placed 'n a nested <code>_index.files</code> folder, accordingly.</p>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Arrr</span></span> This be only avail'ble fer Cap'n Hugo < <code>0.112.0</code></p>
|
||
<blockquote>
|
||
<ul>
|
||
<li>rrrambl'n
|
||
<ul>
|
||
<li>_index.md</li>
|
||
<li>plank
|
||
<ul>
|
||
<li>index.md</li>
|
||
<li><strong>index.files</strong>
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</blockquote>
|
||
</li>
|
||
<li>
|
||
<p>For simple planks, attachments must be placed 'n a folder named like yer plank an' end'n wit' <code>.files</code>.</p>
|
||
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Arrr</span></span> This be only avail'ble fer Cap'n Hugo < <code>0.112.0</code></p>
|
||
<blockquote>
|
||
<ul>
|
||
<li>rrrambl'n
|
||
<ul>
|
||
<li>_index.md</li>
|
||
<li><strong>plank.files</strong>
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
<li>plank.md</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</blockquote>
|
||
</li>
|
||
</ol>
|
||
<h3 id="multilingual">Multilingual</h3>
|
||
<p>Be aware that if ye use a multilingual website, ye will need t' have as many folders as languages an' th' language code must be part o' th' folder name.</p>
|
||
<p>Eg. fer a ship 'n English an' Piratish:</p>
|
||
<blockquote>
|
||
<ul>
|
||
<li>rrrambl'n
|
||
<ul>
|
||
<li>index.en.md</li>
|
||
<li>index.pir.md</li>
|
||
<li>plank
|
||
<ul>
|
||
<li>index.en.md</li>
|
||
<li>index.pir.md</li>
|
||
<li><strong>index.en.files</strong>
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>index.pir.files</strong>
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</blockquote>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="custom-title-list-of-attachments-ending-in-pdf-or-mp4">Custom Title, List o' Attachments End'n 'n pdf or mp4</h3>
|
||
<div class="wrap-code 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>
|
||
<div class="box attachments cstyle transparent">
|
||
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Related <strong>files</strong></div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="../shortcodes/attachments/index.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
|
||
</ul>
|
||
</div>
|
||
<h3 id="info-styled-box-descending-sort-order">Ahoi Styled Box, Descend'n Sort Order</h3>
|
||
<div class="wrap-code 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">"info"</span> <span class="nx">sort</span><span class="p">=</span><span class="s">"desc"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box attachments cstyle info">
|
||
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Ahoi</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="../shortcodes/attachments/index.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/hugo.png">hugo.png</a> (17 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
|
||
</ul>
|
||
</div>
|
||
<h3 id="with-user-defined-color-and-font-awesome-brand-icon">Wit' User-Defined Color an' Font Awesome Brand Ay'con</h3>
|
||
<div class="wrap-code 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">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"fab fa-hackerrank"</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box attachments cstyle default" style="--VARIABLE-BOX-color: fuchsia;">
|
||
<div class="box-label"><i class="fab fa-hackerrank"></i> Attachments</div>
|
||
<ul class="box-content attachments-files">
|
||
<li><a href="../shortcodes/attachments/index.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/hugo.png">hugo.png</a> (17 KB)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
|
||
<li><a href="../shortcodes/attachments/index.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
|
||
</ul>
|
||
</div>
|
||
<h3 id="style-color-title-and-icons">Style, Color, Title an' Ay'cons</h3>
|
||
<p>For further examples fer <strong>style</strong>, <strong>color</strong>, <strong>title</strong> an' <strong>ay'con</strong>, see th' <a href="../shortcodes/notice/index.html"><code>notice</code> shortcode</a> documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="badge">Badge</h1>
|
||
|
||
|
||
<p>Th' <code>badge</code> shortcode displays little markers 'n yer text wit' adjust'ble color, title an' ay'con.</p>
|
||
<p><span class="badge cstyle default"><span class="badge-content">Important</span></span>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title">Version</span><span class="badge-content">6.6.6</span></span>
|
||
<span class="badge cstyle red badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i></span><span class="badge-content">Captain</span></span>
|
||
<span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-info-circle"></i> Ahoi</span><span class="badge-content">New</span></span>
|
||
<span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">Awesome</span></span></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">badge</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Important</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Version"</span> <span class="o">%</span><span class="p">}}</span><span class="mf">6.6.6</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Captain</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">New</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"fab fa-hackerrank"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/badge.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Important"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/badge.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"style"</span> <span class="s">"primary"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"Version"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"6.6.6"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/badge.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"style"</span> <span class="s">"red"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"angle-double-up"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Captain"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/badge.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"style"</span> <span class="s">"info"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"New"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/badge.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"color"</span> <span class="s">"fuchsia"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"fab fa-hackerrank"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Awesome"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><code>default</code></td>
|
||
<td>Th' style scheme used fer th' badge.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td>see notes</td>
|
||
<td>Th' <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> t' be used. If not set, th' chosen color depends on th' <strong>style</strong>. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n color fer th' severity<br>- fer all other styles: th' correspond'n color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td>see notes</td>
|
||
<td>Arbitrary text fer th' badge title. Depend'n on th' <strong>style</strong> there may be a default title. Any given value will overwrite th' default.<br><br>- fer severity styles: th' match'n title fer th' severity<br>- fer all other styles: <em><empty></em><br><br>If ye want no title fer a severity style, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>ay'con</strong></td>
|
||
<td>see notes</td>
|
||
<td><a href="../shortcodes/icon/index.html#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' title. Depend'n on th' <strong>style</strong> there may be a default ay'con. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n ay'con fer th' severity<br>- fer all other styles: <em><empty></em><br><br>If ye want no ay'con fer a severity style, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text fer th' badge.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="style">Style</h3>
|
||
<h4 id="by-severity">By Severity</h4>
|
||
<div class="wrap-code 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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">New</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"note"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Change</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"tip"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Optional</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Break'n</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-info-circle"></i> Ahoi</span><span class="badge-content">New</span></span>
|
||
<span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</span><span class="badge-content">Change</span></span>
|
||
<span class="badge cstyle tip badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-lightbulb"></i> Smarrrt Arrrse</span><span class="badge-content">Optional</span></span>
|
||
<span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i> Arrr</span><span class="badge-content">Break'n</span></span></p>
|
||
<h4 id="by-brand-colors">By Brand Colors</h4>
|
||
<div class="wrap-code 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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"bullhorn"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Announcement"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Mandatory</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"secondary"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"bullhorn"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Announcement"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Optional</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"accent"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"bullhorn"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Announcement"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Special</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle primary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-bullhorn"></i> Announcement</span><span class="badge-content">Mandatory</span></span>
|
||
<span class="badge cstyle secondary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-bullhorn"></i> Announcement</span><span class="badge-content">Optional</span></span>
|
||
<span class="badge cstyle accent badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-bullhorn"></i> Announcement</span><span class="badge-content">Special</span></span></p>
|
||
<h4 id="by-color">By Color</h4>
|
||
<div class="wrap-code 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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"blue"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Blue</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"green"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Green</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"grey"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Grey</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"orange"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Orange</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Red</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle blue badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Blue</span></span>
|
||
<span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Green</span></span>
|
||
<span class="badge cstyle grey badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Grey</span></span>
|
||
<span class="badge cstyle orange badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Orange</span></span>
|
||
<span class="badge cstyle red badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Red</span></span></p>
|
||
<h4 id="by-special-color">By Special Color</h4>
|
||
<div class="wrap-code 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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"default"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Default</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"transparent"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"palette"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Color"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Transparent</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Default</span></span>
|
||
<span class="badge cstyle transparent badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-palette"></i> Color</span><span class="badge-content">Transparent</span></span></p>
|
||
<h3 id="variants">Variants</h3>
|
||
<h4 id="without-icon-and-title-text">Without Ay'con an' Title Text</h4>
|
||
<div class="wrap-code 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">badge</span> <span class="o">%</span><span class="p">}}</span><span class="mf">6.6.6</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">" "</span> <span class="nx">title</span><span class="p">=</span><span class="s">" "</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Captain</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle default"><span class="badge-content">6.6.6</span></span>
|
||
<span class="badge cstyle info"><span class="badge-content">Awesome</span></span>
|
||
<span class="badge cstyle red"><span class="badge-content">Captain</span></span></p>
|
||
<h4 id="without-icon">Without Ay'con</h4>
|
||
<div class="wrap-code 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">badge</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Version"</span> <span class="o">%</span><span class="p">}}</span><span class="mf">6.6.6</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">" "</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Captain</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle default badge-with-title"><span class="badge-title">Version</span><span class="badge-content">6.6.6</span></span>
|
||
<span class="badge cstyle info badge-with-title"><span class="badge-title">Ahoi</span><span class="badge-content">Awesome</span></span>
|
||
<span class="badge cstyle red badge-with-title"><span class="badge-title">Rank</span><span class="badge-content">Captain</span></span></p>
|
||
<h4 id="without-title-text">Without Title Text</h4>
|
||
<div class="wrap-code 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">badge</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"star"</span> <span class="o">%</span><span class="p">}}</span><span class="mf">6.6.6</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">title</span><span class="p">=</span><span class="s">" "</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Captain</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-star"></i></span><span class="badge-content">6.6.6</span></span>
|
||
<span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-info-circle"></i></span><span class="badge-content">Awesome</span></span>
|
||
<span class="badge cstyle red badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i></span><span class="badge-content">Captain</span></span></p>
|
||
<h4 id="all-set">All Set</h4>
|
||
<div class="wrap-code 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">badge</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"star"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Version"</span> <span class="o">%</span><span class="p">}}</span><span class="mf">6.6.6</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Captain</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-star"></i> Version</span><span class="badge-content">6.6.6</span></span>
|
||
<span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-info-circle"></i> Ahoi</span><span class="badge-content">Awesome</span></span>
|
||
<span class="badge cstyle red badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i> Rank</span><span class="badge-content">Captain</span></span></p>
|
||
<h4 id="override-for-severity">Override fer Severity</h4>
|
||
<div class="wrap-code 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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"rocket"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Feature"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-rocket"></i> Feature</span><span class="badge-content">Awesome</span></span>
|
||
<h3 id="other">Other</h3>
|
||
<h4 id="with-user-defined-color-font-awesome-brand-icon-and-markdown-title-and-content">Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title an' Rrrambl'n</h4>
|
||
<div class="wrap-code 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">badge</span> <span class="nx">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"fab fa-hackerrank"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"**Font**"</span> <span class="o">%</span><span class="p">}}</span><span class="o">**</span><span class="nx">Awesome</span><span class="o">**</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i> <strong>Font</strong></span><span class="badge-content" style="background-color: fuchsia;"><strong>Awesome</strong></span></span>
|
||
<h4 id="with-icon-content">Wit' Ay'con Rrrambl'n</h4>
|
||
<p>Ye can combine th' badge wit' th' <a href="../shortcodes/icon/index.html"><code>ay'con</code> shortcode</a> t' create even more stunn'n visuals.</p>
|
||
<p>In this case ye need t' declare <code>{{< badge >}}</code> instead o' <code>{{% badge %}}</code>. Avast, that 'n this case it be not poss'ble t' put markdown 'n th' rrrambl'n.</p>
|
||
<div class="wrap-code 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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">ay'con</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">ay'con</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">Pirate</span><span class="p">{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">ay'con</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">ay'con</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">Pirate</span><span class="p">{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">ay'con</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rank"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">ay'con</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">Pirate</span><span class="p">{{<</span> <span class="o">/</span><span class="nx">badge</span> <span class="p">>}}</span></span></span></code></pre></div><p><span class="badge cstyle primary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i></span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i></span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i></span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i> Pirate</span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title">Rank</span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i></span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title">Rank</span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i> Pirate</span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i> Rank</span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i></span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-angle-double-up"></i> Rank</span><span class="badge-content"><i class="fa-fw fas fa-skull-crossbones"></i> Pirate</span></span></p>
|
||
<h4 id="inside-of-text">Inside o' Text</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="nx">Lorem</span> <span class="nx">ipsum</span> <span class="nx">dolor</span> <span class="nx">sit</span> <span class="nx">amet</span><span class="p">,</span> <span class="nx">graecis</span> <span class="nx">denique</span> <span class="nx">ei</span> <span class="nx">vel</span><span class="p">,</span> <span class="nx">at</span> <span class="nx">duo</span> <span class="nx">primis</span> <span class="nx">mandamus</span><span class="p">.</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"blue"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"rocket"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Awesome</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">badge</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">Et</span> <span class="nx">legere</span> <span class="nx">ocurreret</span> <span class="nx">pri</span><span class="p">,</span> <span class="nx">animal</span> <span class="nx">tacimates</span> <span class="nx">complectitur</span> <span class="nx">ad</span> <span class="nx">cum</span><span class="p">.</span> <span class="nx">Cu</span> <span class="nx">eum</span> <span class="nx">inermis</span> <span class="nx">inimicus</span> <span class="nx">efficiendi</span><span class="p">.</span> <span class="nx">Labore</span> <span class="nx">officiis</span> <span class="nx">his</span> <span class="nx">ex</span><span class="p">,</span> <span class="nx">soluta</span> <span class="nx">officiis</span> <span class="nx">concludaturque</span> <span class="nx">ei</span> <span class="nx">qui</span><span class="p">,</span> <span class="nx">vide</span> <span class="nx">sensibus</span> <span class="nx">vim</span> <span class="nx">ad</span><span class="p">.</span></span></span></code></pre></div><p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. <span class="badge cstyle blue badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-rocket"></i></span><span class="badge-content">Awesome</span></span> 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.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="button">Button</h1>
|
||
|
||
|
||
<p>Th' <code>button</code> shortcode displays a click'ble button wit' adjust'ble color, title an' ay'con.</p>
|
||
<p>
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle warning">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-dragon"></i>
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"dragon"</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></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/button.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"href"</span> <span class="s">"https://gohugo.io/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Get Hugo"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/button.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"href"</span> <span class="s">"https://gohugo.io/"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"style"</span> <span class="s">"warning"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"dragon"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Get Hugo"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Once th' button be clicked, it opens another browser tab fer th' given URL.</p>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>href</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble.<br><br>- if start'n wit' <code>javascript:</code> all follow'n text will be executed 'n yer browser<br>- every other str'n will be interpreted as URL</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><code>transparent</code></td>
|
||
<td>Th' style scheme used fer th' button.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td>see notes</td>
|
||
<td>Th' <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> t' be used. If not set, th' chosen color depends on th' <strong>style</strong>. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n color fer th' severity<br>- fer all other styles: th' correspond'n color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>ay'con</strong></td>
|
||
<td>see notes</td>
|
||
<td><a href="../shortcodes/icon/index.html#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' title. Depend'n on th' <strong>style</strong> there may be a default ay'con. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n ay'con fer th' severity<br>- fer all other styles: <em><empty></em><br><br>If ye want no ay'con fer a severity style, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>iconposit'n</strong></td>
|
||
<td><code>left</code></td>
|
||
<td>Places th' ay'con t' th' <code>left</code> or <code>right</code> o' th' title.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>target</strong></td>
|
||
<td>see notes</td>
|
||
<td>Th' destinat'n frame/window if <strong>href</strong> be an URL. Otherwise th' parameter be not used. This behaves similar t' normal links. If th' parameter be not given it defaults t':<br><br>- th' sett'n o' <code>externalLinkTarget</code> or <code>_blank</code> if not set, fer any address start'n wit' <code>http://</code> or <code>https://</code><br>- no specific value fer all other links</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>type</strong></td>
|
||
<td>see notes</td>
|
||
<td>Th' <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type" target="_blank">button type</a> if <strong>href</strong> be JavaScript. Otherwise th' parameter be not used. If th' parameter be not given it defaults t' <code>button</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td>see notes</td>
|
||
<td>Arbitrary text fer th' button title. Depend'n on th' <strong>style</strong> there may be a default title. Any given value will overwrite th' default.<br><br>- fer severity styles: th' match'n title fer th' severity<br>- fer all other styles: <em><empty></em><br><br>If ye want no title fer a severity style, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces)</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="style">Style</h3>
|
||
<h4 id="by-severity">By Severity</h4>
|
||
<div class="wrap-code 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="nx">style</span><span class="p">=</span><span class="s">"info"</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">style</span><span class="p">=</span><span class="s">"note"</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">style</span><span class="p">=</span><span class="s">"tip"</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">style</span><span class="p">=</span><span class="s">"warning"</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></code></pre></div><p>
|
||
<span class="btn cstyle info">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-info-circle"></i>
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle note">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-exclamation-circle"></i>
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle tip">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-lightbulb"></i>
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle warning">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-exclamation-triangle"></i>
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span></p>
|
||
<h4 id="by-brand-colors">By Brand Colors</h4>
|
||
<div class="wrap-code 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="nx">style</span><span class="p">=</span><span class="s">"primary"</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">style</span><span class="p">=</span><span class="s">"secondary"</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">style</span><span class="p">=</span><span class="s">"accent"</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></code></pre></div><p>
|
||
<span class="btn cstyle primary">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle secondary">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle accent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span></p>
|
||
<h4 id="by-color">By Color</h4>
|
||
<div class="wrap-code 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="nx">style</span><span class="p">=</span><span class="s">"blue"</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">style</span><span class="p">=</span><span class="s">"green"</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">style</span><span class="p">=</span><span class="s">"grey"</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">style</span><span class="p">=</span><span class="s">"orange"</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">style</span><span class="p">=</span><span class="s">"red"</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></code></pre></div><p>
|
||
<span class="btn cstyle blue">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle green">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle grey">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle orange">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle red">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span></p>
|
||
<h4 id="by-special-color">By Special Color</h4>
|
||
<div class="wrap-code 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="nx">style</span><span class="p">=</span><span class="s">"default"</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">style</span><span class="p">=</span><span class="s">"transparent"</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></code></pre></div><p>
|
||
<span class="btn cstyle default">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span></p>
|
||
<h3 id="icon">Ay'con</h3>
|
||
<h4 id="empty">Empty</h4>
|
||
<div class="wrap-code 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="nx">ay'con</span><span class="p">=</span><span class="s">" "</span> <span class="o">%</span><span class="p">}}{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
|
||
</a>
|
||
</span>
|
||
<h4 id="only">Only</h4>
|
||
<div class="wrap-code 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="nx">ay'con</span><span class="p">=</span><span class="s">"download"</span> <span class="o">%</span><span class="p">}}{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-download"></i>
|
||
|
||
</a>
|
||
</span>
|
||
<h4 id="to-the-left">T' th' Left</h4>
|
||
<div class="wrap-code 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="nx">ay'con</span><span class="p">=</span><span class="s">"download"</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></code></pre></div>
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-download"></i>
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
<h4 id="to-the-right">T' th' Right</h4>
|
||
<div class="wrap-code 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="nx">ay'con</span><span class="p">=</span><span class="s">"download"</span> <span class="nx">iconposit'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="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo
|
||
<i class="fa-fw fas fa-download"></i>
|
||
</a>
|
||
</span>
|
||
<h4 id="override-for-severity">Override fer Severity</h4>
|
||
<div class="wrap-code 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="nx">ay'con</span><span class="p">=</span><span class="s">"dragon"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</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></code></pre></div>
|
||
<span class="btn cstyle warning">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-dragon"></i>
|
||
Get Cap'n Hugo
|
||
</a>
|
||
</span>
|
||
<h3 id="target">Target</h3>
|
||
<div class="wrap-code 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="nx">target</span><span class="p">=</span><span class="s">"_self"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">Cap'n Hugo</span> <span class="nx">'n</span> <span class="nx">same</span> <span class="nx">window</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">button</span> <span class="nx">href</span><span class="p">=</span><span class="s">"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="nx">'n</span> <span class="nx">new</span> <span class="nx">Window</span><span class="o">/</span><span class="nf">Frame</span> <span class="p">(</span><span class="k">default</span><span class="p">){{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p>
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_self">
|
||
Get Cap'n Hugo 'n same Window/Frame
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Cap'n Hugo 'n new Window/Frame (default)
|
||
</a>
|
||
</span></p>
|
||
<h3 id="other">Other</h3>
|
||
<h4 id="with-user-defined-color-font-awesome-brand-icon-and-markdown-title">Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title</h4>
|
||
<div class="wrap-code 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="nx">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"fab fa-hackerrank"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="o">**</span><span class="nx">Cap'n Hugo</span><span class="o">**</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<span class="btn cstyle default" style="--VARIABLE-BOX-color: fuchsia;">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fab fa-hackerrank"></i>
|
||
Get <strong>Cap'n Hugo</strong>
|
||
</a>
|
||
</span>
|
||
<h4 id="severity-style-with-all-defaults">Severity Style wit' All Defaults</h4>
|
||
<div class="wrap-code 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="nx">style</span><span class="p">=</span><span class="s">"tip"</span> <span class="o">%</span><span class="p">}}{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<span class="btn cstyle tip">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-lightbulb"></i>
|
||
Smarrrt Arrrse
|
||
</a>
|
||
</span>
|
||
<h4 id="button-to-internal-page">Button t' Internal Plank</h4>
|
||
<div class="wrap-code 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">"/index.html"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Home</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<span class="btn cstyle transparent">
|
||
<a href="../index.html">
|
||
Home
|
||
</a>
|
||
</span>
|
||
<h4 id="button-with-javascript-action">Button wit' JavaScript Act'n</h4>
|
||
<p>If yer JavaScript act'n does not change th' focus afterwards, make sure t' call <code>this.blur()</code> 'n th' end t' unselect th' button.</p>
|
||
<div class="wrap-code 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">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"bullhorn"</span> <span class="nx">href</span><span class="p">=</span><span class="s">"javascript:alert('Hello world!');this.blur();"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Shout</span> <span class="nx">it</span> <span class="nx">out</span><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">button</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<span class="btn cstyle primary">
|
||
<button onclick="alert('Hello world!');this.blur();" type="button">
|
||
<i class="fa-fw fas fa-bullhorn"></i>
|
||
Shout it out
|
||
</button>
|
||
</span>
|
||
<h4 id="button-within-a-form-element">Button within a <code>form</code> Element</h4>
|
||
<p>T' use native HTML elements 'n yer Marrrkdown, add this 'n yer <code>config.toml</code></p>
|
||
<div class="wrap-code 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 class="nx">goldmark</span><span class="p">.</span><span class="nx">renderer</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">unsafe</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div><div class="wrap-code 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">form</span> <span class="na">act'n</span><span class="o">=</span><span class="s">"../../search.html"</span> <span class="na">method</span><span class="o">=</span><span class="s">"get"</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p"><</span><span class="nt">input</span> <span class="na">name</span><span class="o">=</span><span class="s">"search-by-detail"</span> <span class="na">class</span><span class="o">=</span><span class="s">"search-by"</span> <span class="na">type</span><span class="o">=</span><span class="s">"search"</span><span class="p">></span>
|
||
</span></span><span class="line"><span class="cl"> {{% button type="submit" style="secondary" icon="search" %}}Search{{% /button %}}
|
||
</span></span><span class="line"><span class="cl"><span class="p"></</span><span class="nt">form</span><span class="p">></span></span></span></code></pre></div><form action="../../search.html" method="get">
|
||
<div class="searchform" style="width: 20vw;">
|
||
<input name="search-by-detail" class="search-by" type="search" placeholder="Search...">
|
||
|
||
<span class="btn cstyle secondary">
|
||
<button type="submit">
|
||
<i class="fa-fw fas fa-search"></i>
|
||
Search
|
||
</button>
|
||
</span>
|
||
</div>
|
||
</form>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="children">Children</h1>
|
||
|
||
|
||
<p>Th' <code>children</code> shortcode lists th' child planks o' th' current plank an' its descendants.</p>
|
||
|
||
<ul class="children children-li children-sort-weight">
|
||
|
||
<li><a href="../shortcodes/children/test/index.html">plank X</a></li>
|
||
<li><a href="../shortcodes/children/children-1/index.html">plank 1</a></li>
|
||
<li><a href="../shortcodes/children/children-2/index.html">plank 2</a></li>
|
||
<li><a href="../shortcodes/children/children-3/index.html">plank 3</a></li>
|
||
</ul>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="nx">sort</span><span class="p">=</span><span class="s">"weight"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/children.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"sort"</span> <span class="s">"weight"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>containerstyle</strong></td>
|
||
<td><code>ul</code></td>
|
||
<td>Choose th' style used t' group all children. It could be any HTML tag name.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><code>li</code></td>
|
||
<td>Choose th' style used t' display each descendant. It could be any HTML tag name.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>showhidden</strong></td>
|
||
<td><code>false</code></td>
|
||
<td>When <code>true</code>, child planks hidden from th' menu will be displayed as well.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>descript'n</strong></td>
|
||
<td><code>false</code></td>
|
||
<td>When <code>true</code> shows a short text under each plank 'n th' list. When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken - <a href="https://gohugo.io/content/summaries/" target="_blank">read more info about summaries on gohugo.io</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>depth</strong></td>
|
||
<td><code>1</code></td>
|
||
<td>Th' depth o' descendants t' display. For example, if th' value be <code>2</code>, th' shortcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. <code>999</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>sort</strong></td>
|
||
<td><code>auto</code></td>
|
||
<td>Th' sort criteria o' th' displayed list.<br><br>- <code>auto</code> defaults t' <a href="../cont/pages/index.html#frontmatter-configuration"><code>ordersectionsby</code> o' th' planks frontmatter</a><br> or t' <a href="../basics/configuration/index.html#global-site-parameters"><code>ordersectionsby</code> o' th' ship configurat'n</a><br> or t' <code>weight</code><br>- <code>weight</code><br>- <code>title</code><br>- <code>linktitle</code><br>- <code>modifieddate</code><br>- <code>expirydate</code><br>- <code>publishdate</code><br>- <code>date</code><br>- <code>length</code><br>- <code>default</code> adher'n t' Hugo’s default sort criteria</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="all-default">All Default</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">children</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="../shortcodes/children/test/index.html">plank X</a></li>
|
||
<li><a href="../shortcodes/children/children-1/index.html">plank 1</a></li>
|
||
<li><a href="../shortcodes/children/children-2/index.html">plank 2</a></li>
|
||
<li><a href="../shortcodes/children/children-3/index.html">plank 3</a></li>
|
||
</ul>
|
||
<h3 id="with-description">Wit' Descript'n</h3>
|
||
<div class="wrap-code 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="../shortcodes/children/test/index.html">plank X</a><p>This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n...
|
||
</p></li>
|
||
<li><a href="../shortcodes/children/children-1/index.html">plank 1</a><p>This be a demo child plank</p></li>
|
||
<li><a href="../shortcodes/children/children-2/index.html">plank 2</a><p>This be a demo child plank wit' no descript'n.
|
||
So its rrrambl'n be used as descript'n.</p></li>
|
||
<li><a href="../shortcodes/children/children-3/index.html">plank 3</a><p>This be a demo child plank</p></li>
|
||
</ul>
|
||
<h3 id="infinite-depth-and-hidden-pages">Infinite Depth an' Hidden Planks</h3>
|
||
<div class="wrap-code 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="../shortcodes/children/test/index.html">plank X</a><ul>
|
||
</ul></li>
|
||
<li><a href="../shortcodes/children/children-1/index.html">plank 1</a><ul>
|
||
|
||
<li><a href="../shortcodes/children/children-1/children-1-1/index.html">plank 1-1</a><ul>
|
||
|
||
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">plank 1-1-1 (hidden)</a><ul>
|
||
|
||
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html">plank 1-1-1-1</a><ul>
|
||
|
||
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html">plank 1-1-1-1-1 (hidden)</a><ul>
|
||
|
||
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html">plank 1-1-1-1-1-1</a><ul>
|
||
</ul></li></ul></li></ul></li></ul></li>
|
||
<li><span>plank 1-1-2 (headless)</span><ul>
|
||
|
||
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">plank 1-1-2-1</a><ul>
|
||
</ul></li>
|
||
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html">plank 1-1-2-2</a><ul>
|
||
</ul></li></ul></li>
|
||
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">plank 1-1-3</a><ul>
|
||
</ul></li></ul></li></ul></li>
|
||
<li><a href="../shortcodes/children/children-2/index.html">plank 2</a><ul>
|
||
</ul></li>
|
||
<li><a href="../shortcodes/children/children-3/index.html">plank 3</a><ul>
|
||
|
||
<li><a href="../shortcodes/children/children-3/test3/index.html">plank 3-1</a><ul>
|
||
</ul></li></ul></li>
|
||
<li><a href="../shortcodes/children/children-4/index.html">plank 4 (hidden)</a><ul>
|
||
</ul></li>
|
||
</ul>
|
||
<h3 id="heading-styles-for-container-and-elements">Head'n Styles fer Container an' Elements</h3>
|
||
<div class="wrap-code 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="../shortcodes/children/test/index.html">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="../shortcodes/children/children-1/index.html">plank 1</a></h2><p>This be a demo child plank</p>
|
||
|
||
<h3><a href="../shortcodes/children/children-1/children-1-1/index.html">plank 1-1</a></h3><p>This be a demo child plank</p>
|
||
|
||
<h4><span>plank 1-1-2 (headless)</span></h4><p>This be a demo child plank</p>
|
||
<h4><a href="../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">plank 1-1-3</a></h4><p>This be a demo child plank</p>
|
||
<h2><a href="../shortcodes/children/children-2/index.html">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="../shortcodes/children/children-3/index.html">plank 3</a></h2><p>This be a demo child plank</p>
|
||
|
||
<h3><a href="../shortcodes/children/children-3/test3/index.html">plank 3-1</a></h3><p>This be a plain plank test nested 'n a parent</p>
|
||
|
||
</div>
|
||
<h3 id="divs-for-group-and-element-styles">Divs fer Group an' Element Styles</h3>
|
||
<div class="wrap-code 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">"3"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="children children-div children-sort-">
|
||
|
||
<div><a href="../shortcodes/children/test/index.html">plank X</a></div>
|
||
|
||
<div><a href="../shortcodes/children/children-1/index.html">plank 1</a></div>
|
||
|
||
<div><a href="../shortcodes/children/children-1/children-1-1/index.html">plank 1-1</a></div>
|
||
|
||
<div><span>plank 1-1-2 (headless)</span></div>
|
||
<div><a href="../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">plank 1-1-3</a></div>
|
||
<div><a href="../shortcodes/children/children-2/index.html">plank 2</a></div>
|
||
|
||
<div><a href="../shortcodes/children/children-3/index.html">plank 3</a></div>
|
||
|
||
<div><a href="../shortcodes/children/children-3/test3/index.html">plank 3-1</a></div>
|
||
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsct'ns o' Children</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/children/index.html">Children</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="plank-x">plank X</h1>
|
||
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="../pir/tags/non-hidden/index.html">non-hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="plank-1">plank 1</h1>
|
||
|
||
|
||
<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="../shortcodes/children/children-1/children-1-1/index.html">plank 1-1</a></li>
|
||
</ul>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsct'ns o' plank 1</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="../pir/tags/non-hidden/index.html">non-hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="plank-1-1">plank 1-1</h1>
|
||
|
||
|
||
<p>This be a demo child plank wit' a hidden child. Ye can still access th' hidden child <a href="../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">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="../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">plank 1-1-1 (hidden)</a></li>
|
||
<li><span>plank 1-1-2 (headless)</span></li>
|
||
<li><a href="../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">plank 1-1-3</a></li>
|
||
</ul>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsct'ns o' plank 1-1</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="../pir/tags/headless/index.html">headless</a></li>
|
||
<li><a class="term-link" href="../pir/tags/non-hidden/index.html">non-hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="plank-1-1-2-headless">plank 1-1-2 (headless)</h1>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsct'ns o' plank 1-1-2 (headless)</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="../pir/tags/non-hidden/index.html">non-hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="plank-1-1-2-1">plank 1-1-2-1</h1>
|
||
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="../pir/tags/non-hidden/index.html">non-hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="plank-1-1-2-2">plank 1-1-2-2</h1>
|
||
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="../pir/tags/non-hidden/index.html">non-hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="plank-1-1-3">plank 1-1-3</h1>
|
||
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
</section>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="../pir/tags/non-hidden/index.html">non-hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="plank-2">plank 2</h1>
|
||
|
||
|
||
<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 class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="../pir/tags/non-hidden/index.html">non-hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="plank-3">plank 3</h1>
|
||
|
||
|
||
<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="../shortcodes/children/children-3/test3/index.html">plank 3-1</a></li>
|
||
</ul>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsct'ns o' plank 3</h1>
|
||
<article class="default">
|
||
<header class="headline">
|
||
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="../pir/tags/children/index.html">Children</a></li>
|
||
<li><a class="term-link" href="../pir/tags/non-hidden/index.html">non-hidden</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
<h1 id="plank-3-1">plank 3-1</h1>
|
||
|
||
|
||
<p>This be a plain demo child plank.</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
</section>
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="expand">Expand</h1>
|
||
|
||
|
||
<p>Th' <code>expand</code> shortcode displays an expandable/collaps'ble section o' text.</p>
|
||
|
||
<div class="expand">
|
||
<input type="checkbox" id="R-expand-388d17e5a3fe28b1cbab8279991d0bff" aria-controls="R-expandcontent-388d17e5a3fe28b1cbab8279991d0bff" >
|
||
<label class="expand-label" for="R-expand-388d17e5a3fe28b1cbab8279991d0bff" >
|
||
<i class="fas fa-chevron-down"></i>
|
||
<i class="fas fa-chevron-right"></i>
|
||
Expand me…
|
||
</label>
|
||
<div id="R-expandcontent-388d17e5a3fe28b1cbab8279991d0bff" class="expand-content">
|
||
|
||
<p>Thank ye!</p>
|
||
<p>That’s some text wit' a footnote<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></p>
|
||
<p>That’s some more text wit' a footnote.<sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup></p>
|
||
<div class="footnotes" role="doc-endnotes">
|
||
<hr>
|
||
<ol>
|
||
<li id="fn:1">
|
||
<p>An' that’s th' footnote. <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
<li id="fn:2">
|
||
<p>Anyth'n o' interest goes here.</p>
|
||
<p>Blue light glows blue. <a href="#fnref:2" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>This only works 'n modern browsers flawlessly. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Expand me..."</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Thank</span> <span class="nx">ye</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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="o">%</span><span class="p">}}</span><span class="nx">Thank</span> <span class="nx">ye</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/expand.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"Expand me..."</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Thank ye!"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Posit'n</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td>1</td>
|
||
<td><code>"Expand me..."</code></td>
|
||
<td>Arbitrary text t' appear next t' th' expand/collapse ay'con.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>open</strong></td>
|
||
<td>2</td>
|
||
<td><code>false</code></td>
|
||
<td>When <code>true</code> th' rrrambl'n text will be initially shown as expanded.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text t' be displayed on expand.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="all-defaults">All Defaults</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Yes</span><span class="p">,</span> <span class="nx">ye</span> <span class="nx">did</span> <span class="nx">it</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="expand">
|
||
<input type="checkbox" id="R-expand-1fa4070378ec3ad0a2534b12010cd30e" aria-controls="R-expandcontent-1fa4070378ec3ad0a2534b12010cd30e" >
|
||
<label class="expand-label" for="R-expand-1fa4070378ec3ad0a2534b12010cd30e" >
|
||
<i class="fas fa-chevron-down"></i>
|
||
<i class="fas fa-chevron-right"></i>
|
||
Expand me…
|
||
</label>
|
||
<div id="R-expandcontent-1fa4070378ec3ad0a2534b12010cd30e" class="expand-content">
|
||
<p>
|
||
Yes, ye did it!</div>
|
||
</div>
|
||
<h3 id="initially-expanded">Initially Expanded</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Expand me..."</span> <span class="nx">open</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span><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 class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="expand">
|
||
<input type="checkbox" id="R-expand-b6d3cf5c571d9b1bdc0a1d8d11d480b1" aria-controls="R-expandcontent-b6d3cf5c571d9b1bdc0a1d8d11d480b1" checked>
|
||
<label class="expand-label" for="R-expand-b6d3cf5c571d9b1bdc0a1d8d11d480b1" >
|
||
<i class="fas fa-chevron-down"></i>
|
||
<i class="fas fa-chevron-right"></i>
|
||
Expand me…
|
||
</label>
|
||
<div id="R-expandcontent-b6d3cf5c571d9b1bdc0a1d8d11d480b1" class="expand-content">
|
||
<p>
|
||
No need t' press ye!</div>
|
||
</div>
|
||
<h3 id="arbitrary-text">Arbitrary Text</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Show me almost **endless** possibilities"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</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="nx">standard</span> <span class="nx">markdown</span> <span class="nx">rules</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">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">possibilities</span> <span class="nx">be</span> <span class="nf">endless</span> <span class="p">(</span><span class="nx">almost</span> <span class="o">-</span> <span class="nx">includ'n</span> <span class="nx">other</span> <span class="nx">shorrrtcodes</span> <span class="nx">may</span> <span class="nx">or</span> <span class="nx">may</span> <span class="nx">not</span> <span class="nx">work</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="expand">
|
||
<input type="checkbox" id="R-expand-71f6712f87a6c0fa79a7b0d2a5bf432b" aria-controls="R-expandcontent-71f6712f87a6c0fa79a7b0d2a5bf432b" >
|
||
<label class="expand-label" for="R-expand-71f6712f87a6c0fa79a7b0d2a5bf432b" >
|
||
<i class="fas fa-chevron-down"></i>
|
||
<i class="fas fa-chevron-right"></i>
|
||
Show me almost <strong>endless</strong> possibilities
|
||
</label>
|
||
<div id="R-expandcontent-71f6712f87a6c0fa79a7b0d2a5bf432b" class="expand-content">
|
||
|
||
<p>Ye can add standard markdown rules:</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" target="_blank">links</a></li>
|
||
<li>etc.</li>
|
||
</ul>
|
||
<div class="wrap-code 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' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)</p>
|
||
</blockquote>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="highlight">Highlight</h1>
|
||
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Arrr! Pirrrates</div>
|
||
<div class="box-content">
|
||
|
||
<p>Fello' pirrrates, grog made us dizzy! Be awarrre <b>some stuff may look weird</b> in this trrranslat'n. Like <b>Merrrmaids</b>, do'n <b>math or chemistrrry</b> and stuff.</p>
|
||
</div>
|
||
</div>
|
||
<p>Th' <code>highlight</code> shortcode renders yer code wit' a rules highlighter.</p>
|
||
|
||
|
||
<div class="tab-panel" data-tab-group="f014e04754d81f56379f3a4bf24499b8">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('f014e04754d81f56379f3a4bf24499b8','python')"
|
||
>
|
||
<span class="tab-nav-text">python</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="python"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-py" data-lang="py"><span class="line"><span class="ln">1</span><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>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>This shortcode be fully compat'ble wit' Hugo’s <a href="https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode" target="_blank"><code>highlight</code> shortcode</a> but <strong>offers some extensions</strong>.</p>
|
||
<p>It be called interchangeably 'n th' same way as Hugo’s own shortcode provid'n positional parameter or by simply us'n codefences.</p>
|
||
<p>Ye be free t' also call this shortcode from yer own partials. In this case it resembles Hugo’s <a href="https://gohugo.io/functions/highlight/" target="_blank"><code>highlight</code> funct'n</a> rules if ye call this shortcode as a partial us'n compatiblity rules.</p>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports codefences (eg. GitHub) an' so yer markdown becomes more port'ble.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="codefence"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','codefence')"
|
||
>
|
||
<span class="tab-nav-text">codefence</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial-compat"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial-compat')"
|
||
>
|
||
<span class="tab-nav-text">partial (compat)</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="codefence"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">```py { lineNos="true" wrap="true" title="python" }
|
||
</span></span><span class="line"><span class="cl">print("Hello World!")
|
||
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">highlight</span> <span class="nx">lineNos</span><span class="p">=</span><span class="s">"true"</span> <span class="kd">type</span><span class="p">=</span><span class="s">"py"</span> <span class="nx">wrap</span><span class="p">=</span><span class="s">"true"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"python"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">"Hello World!"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">highlight</span> <span class="nx">py</span> <span class="s">"lineNos=true,wrap=true,title=python"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">"Hello World!"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/highlight.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"print(\"Hello World!\")"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"lineNos"</span> <span class="s">"true"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"type"</span> <span class="s">"py"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"wrap"</span> <span class="s">"true"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"python"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial-compat"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/highlight.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"print(\"Hello World!\")"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"options"</span> <span class="s">"lineNos=true,wrap=true,title=python"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"type"</span> <span class="s">"py"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Posit'n</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>type</strong></td>
|
||
<td>1</td>
|
||
<td><em><empty></em></td>
|
||
<td>Th' language o' th' code t' highlight. Choose from one o' th' <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages" target="_blank">supported languages</a>. Case-insensitive.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td></td>
|
||
<td><em><empty></em></td>
|
||
<td><strong>Extension</strong>. Arbitrary title fer code. This displays th' code like a <a href="../shortcodes/tab/index.html">single tab</a> if <code>hl_inline=false</code> (which be Hugos default).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>wrap</strong></td>
|
||
<td></td>
|
||
<td>see notes</td>
|
||
<td><strong>Extension</strong>. When <code>true</code> th' rrrambl'n may wrap on long lines otherwise it will be scroll'ble.<br><br>Th' default value can be set 'n yer <code>config.toml</code> an' overwritten via frontmatter. <a href="#configuration">See below</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>opt'ns</strong></td>
|
||
<td>2</td>
|
||
<td><em><empty></em></td>
|
||
<td>An optional, comma-separated list o' zero or more <a href="https://gohugo.io/functions/highlight/#options" target="_blank">Cap'n Hugo supported opt'ns</a> as well as extension parameter from this t'ble.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><option></strong></em></td>
|
||
<td></td>
|
||
<td><em><empty></em></td>
|
||
<td>Any o' <a href="https://gohugo.io/functions/highlight/#options" target="_blank">Hugo’s supported opt'ns</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td></td>
|
||
<td><em><empty></em></td>
|
||
<td>Yer code t' highlight.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="configuration">Configurat'n</h2>
|
||
<p>Default values fer <a href="https://gohugo.io/functions/highlight/#options" target="_blank">Hugo’s supported opt'ns</a> can be set via <a href="https://gohugo.io/getting-started/configuration-markup/#highlight" target="_blank">goldmark sett'ns</a> 'n yer <code>config.toml</code></p>
|
||
<p>Default values fer extension opt'ns can be set via params sett'ns 'n yer <code>config.toml</code> or be overwritten by frontmatter fer each individual plank.</p>
|
||
<h3 id="global-configuration-file">Global Configurat'n File</h3>
|
||
<h4 id="recommended-settings">Recommended Sett'ns</h4>
|
||
<div class="wrap-code 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"># line numbers 'n a t'ble layout will shift if code be wrapp'n, so better</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># use inline; besides that visually both layouts have th' same look an' behavior</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">lineNumbersInT'ble</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"># if `guessSyntax = true`, there will be no unstyled code even if no language</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># mandatory sett'n fer yer ship if ye want t' use Merrrmaid or Math codefences</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">guessSyntax</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># th' shipped variants come wit' their own modified chroma rules highlightn'n</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># style which be imported 'n theme-relearn-light.css, theme-relearn-dark.css, etc.;</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># if ye want t' use a predefined style instead:</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># - remove `noClasses` or set `noClasses = true`</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># - set `style` t' a predefined style name</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">noClasses</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># style = "tango"</span></span></span></code></pre></div><h4 id="optional-settings">Optional Sett'ns</h4>
|
||
<div class="wrap-code 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">highlightWrap</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div><h3 id="pages-frontmatter">Page’s Frontmatter</h3>
|
||
<div class="wrap-code 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">highlightWrap</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div><h2 id="examples">Examples</h2>
|
||
<h3 id="line-numbers-with-starting-offset">Line Numbers wit' Start'n Offset</h3>
|
||
<p>As mentioned above, line numbers 'n a <code>t'ble</code> layout will shift if code be wrapp'n, so better use <code>inline</code>. T' make th'ns easier fer ye, set <code>lineNumbersInT'ble = false</code> 'n yer <code>config.toml</code> an' add <code>lineNos = true</code> when call'n th' shortcode instead o' th' specific values <code>t'ble</code> or <code>inline</code>.</p>
|
||
<div class="wrap-code 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">highlight</span> <span class="nx">lineNos</span><span class="p">=</span><span class="s">"true"</span> <span class="nx">lineNoStart</span><span class="p">=</span><span class="s">"666"</span> <span class="kd">type</span><span class="p">=</span><span class="s">"py"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">#</span> <span class="nx">th'</span> <span class="nx">hardest</span> <span class="nx">part</span> <span class="nx">be</span> <span class="nx">t'</span> <span class="nx">start</span> <span class="nx">writ'n</span> <span class="nx">code</span><span class="p">;</span> <span class="nx">here</span><span class="err">'</span><span class="nx">s</span> <span class="nx">a</span> <span class="nx">kickstart</span><span class="p">;</span> <span class="nx">just</span> <span class="nx">copy</span> <span class="nx">an'</span> <span class="nx">paste</span> <span class="nx">this</span><span class="p">;</span> <span class="nx">it</span><span class="err">'</span><span class="nx">s</span> <span class="nx">free</span><span class="p">;</span> <span class="nx">th'</span> <span class="nx">next</span> <span class="nx">lines</span> <span class="nx">will</span> <span class="nx">cost</span> <span class="nx">ye</span> <span class="nx">serious</span> <span class="nx">credits</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">"Hello"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">" "</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">"World"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s">"!"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span></span></span></code></pre></div><div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-py" data-lang="py"><span class="line"><span class="ln">666</span><span class="cl"><span class="c1"># th' hardest part be t' start writ'n code; here's a kickstart; just copy an' paste this; it's free; th' next lines will cost ye serious credits</span>
|
||
</span></span><span class="line"><span class="ln">667</span><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Hello"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="ln">668</span><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">" "</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="ln">669</span><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"World"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="ln">670</span><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"!"</span><span class="p">)</span></span></span></code></pre></div>
|
||
<h3 id="codefence-with-title">Codefence wit' Title</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">```py { title="python" }
|
||
</span></span><span class="line"><span class="cl"><span class="gh"># a bit shorter
|
||
</span></span></span><span class="line"><span class="cl"><span class="gh"></span>print("Hello World!")
|
||
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div>
|
||
|
||
<div class="tab-panel" data-tab-group="5cbdd2c015d63a5175d25cc28175fb42">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('5cbdd2c015d63a5175d25cc28175fb42','python')"
|
||
>
|
||
<span class="tab-nav-text">python</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="python"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-py" data-lang="py"><span class="line"><span class="cl"><span class="c1"># a bit shorter</span>
|
||
</span></span><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>
|
||
</div>
|
||
</div><h3 id="with-wrap">Wit' Wrap</h3>
|
||
<div class="wrap-code 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">highlight</span> <span class="kd">type</span><span class="p">=</span><span class="s">"py"</span> <span class="nx">wrap</span><span class="p">=</span><span class="s">"true"</span> <span class="nx">hl_lines</span><span class="p">=</span><span class="s">"2"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">#</span> <span class="nx">Quicksort</span> <span class="nx">Python</span> <span class="nx">One</span><span class="o">-</span><span class="nx">liner</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">lambda</span> <span class="nx">L</span><span class="p">:</span> <span class="p">[]</span> <span class="k">if</span> <span class="nx">L</span><span class="o">==</span><span class="p">[]</span> <span class="k">else</span> <span class="nf">qsort</span><span class="p">([</span><span class="nx">x</span> <span class="k">fer</span> <span class="nx">x</span> <span class="nx">'n</span> <span class="nx">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="nx">x</span><span class="p"><</span> <span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span> <span class="o">+</span> <span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="nf">qsort</span><span class="p">([</span><span class="nx">x</span> <span class="k">fer</span> <span class="nx">x</span> <span class="nx">'n</span> <span class="nx">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="nx">x</span><span class="o">>=</span><span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">#</span> <span class="nx">Some</span> <span class="nx">more</span> <span class="nx">stuff</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span></span></span></code></pre></div><div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-py" data-lang="py"><span class="line"><span class="cl"><span class="c1"># Quicksort Python One-liner</span>
|
||
</span></span><span class="line hl"><span class="cl"><span class="k">lambda</span> <span class="n">L</span><span class="p">:</span> <span class="p">[]</span> <span class="k">if</span> <span class="n">L</span><span class="o">==</span><span class="p">[]</span> <span class="k">else</span> <span class="n">qsort</span><span class="p">([</span><span class="n">x</span> <span class="k">fer</span> <span class="n">x</span> <span class="ow">'n</span> <span class="n">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">x</span><span class="o"><</span> <span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span> <span class="o">+</span> <span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="n">qsort</span><span class="p">([</span><span class="n">x</span> <span class="k">fer</span> <span class="n">x</span> <span class="ow">'n</span> <span class="n">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">x</span><span class="o">>=</span><span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c1"># Some more stuff</span></span></span></code></pre></div>
|
||
<h3 id="without-wrap">Without Wrap</h3>
|
||
<div class="wrap-code 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">highlight</span> <span class="kd">type</span><span class="p">=</span><span class="s">"py"</span> <span class="nx">wrap</span><span class="p">=</span><span class="s">"false"</span> <span class="nx">hl_lines</span><span class="p">=</span><span class="s">"2"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">#</span> <span class="nx">Quicksort</span> <span class="nx">Python</span> <span class="nx">One</span><span class="o">-</span><span class="nx">liner</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">lambda</span> <span class="nx">L</span><span class="p">:</span> <span class="p">[]</span> <span class="k">if</span> <span class="nx">L</span><span class="o">==</span><span class="p">[]</span> <span class="k">else</span> <span class="nf">qsort</span><span class="p">([</span><span class="nx">x</span> <span class="k">fer</span> <span class="nx">x</span> <span class="nx">'n</span> <span class="nx">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="nx">x</span><span class="p"><</span> <span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span> <span class="o">+</span> <span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="nf">qsort</span><span class="p">([</span><span class="nx">x</span> <span class="k">fer</span> <span class="nx">x</span> <span class="nx">'n</span> <span class="nx">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="nx">x</span><span class="o">>=</span><span class="nx">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">#</span> <span class="nx">Some</span> <span class="nx">more</span> <span class="nx">stuff</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</span> <span class="p">>}}</span></span></span></code></pre></div><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-py" data-lang="py"><span class="line"><span class="cl"><span class="c1"># Quicksort Python One-liner</span>
|
||
</span></span><span class="line hl"><span class="cl"><span class="k">lambda</span> <span class="n">L</span><span class="p">:</span> <span class="p">[]</span> <span class="k">if</span> <span class="n">L</span><span class="o">==</span><span class="p">[]</span> <span class="k">else</span> <span class="n">qsort</span><span class="p">([</span><span class="n">x</span> <span class="k">fer</span> <span class="n">x</span> <span class="ow">'n</span> <span class="n">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">x</span><span class="o"><</span> <span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span> <span class="o">+</span> <span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="n">qsort</span><span class="p">([</span><span class="n">x</span> <span class="k">fer</span> <span class="n">x</span> <span class="ow">'n</span> <span class="n">L</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">x</span><span class="o">>=</span><span class="n">L</span><span class="p">[</span><span class="mi">0</span><span class="p">]])</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c1"># Some more stuff</span></span></span></code></pre></div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="icon">Icon</h1>
|
||
|
||
|
||
<p>Th' <code>ay'con</code> shortcode displays ay'cons us'n th' <a href="https://fontawesome.com" target="_blank">Font Awesome</a> library.</p>
|
||
<p><i class="fa-fw fas fa-exclamation-triangle"></i>
|
||
<i class="fa-fw fas fa-angle-double-up"></i>
|
||
<i class="fa-fw fas fa-skull-crossbones"></i></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' positional parameter ye be free t' also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">ay'con</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"exclamation-triangle"</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">ay'con</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"angle-double-up"</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">ay'con</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"skull-crossbones"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">ay'con</span> <span class="nx">exclamat'n</span><span class="o">-</span><span class="nx">triangle</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">ay'con</span> <span class="nx">angle</span><span class="o">-</span><span class="nx">do'ble</span><span class="o">-</span><span class="nx">up</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">ay'con</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/icon.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"exclamation-triangle"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/icon.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"angle-double-up"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/icon.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"skull-crossbones"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Posit'n</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>ay'con</strong></td>
|
||
<td>1</td>
|
||
<td><em><empty></em></td>
|
||
<td><a href="#finding-an-icon">Font Awesome ay'con name</a> t' be displayed. It will be displayed 'n th' text color o' its accord'n context.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="finding-an-icon">Find'n an ay'con</h3>
|
||
<p>Browse through th' avail'ble ay'cons 'n th' <a href="https://fontawesome.com/v5/search?m=free" target="_blank">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" target="_blank">heart</a>, copy th' ay'con name an' paste into th' Marrrkdown rrrambl'n.</p>
|
||
<h3 id="customising-icons">Customis'n Ay'cons</h3>
|
||
<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" target="_blank">web fonts wit' CSS</a> fer more.</p>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="standard-usage">Standard Usage</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="nx">Built</span> <span class="nx">wit'</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">ay'con</span> <span class="nx">heart</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">by</span> <span class="nx">Relearrrn</span> <span class="nx">an'</span> <span class="nx">Cap'n Hugo</span></span></span></code></pre></div><p>Built wit' <i class="fa-fw fas fa-heart"></i> by Relearrrn an' Cap'n Hugo</p>
|
||
<h3 id="advanced-html-usage">Advanced HTML Usage</h3>
|
||
<p>While th' shortcode simplifies us'n standard ay'cons, th' ay'con customizat'n an' other advanced features o' th' Font Awesome library require ye t' use HTML directly. Paste th' <code><i></code> HTML into marrrkup, an' Font Awesome will board th' relevant ay'con.</p>
|
||
<div class="wrap-code 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>Built wit' <i class="fas fa-heart"></i> by Relearrrn an' Cap'n Hugo</p>
|
||
<p>T' use these native HTML elements 'n yer Marrrkdown, add this 'n yer <code>config.toml</code>:</p>
|
||
<div class="wrap-code 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 class="nx">goldmark</span><span class="p">.</span><span class="nx">renderer</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">unsafe</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="include">Include</h1>
|
||
|
||
|
||
<p>Th' <code>include</code> shortcode includes other files from yer project inside o' th' current plank.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">include</span> <span class="nx">file</span><span class="p">=</span><span class="s">"shortcodes/INCLUDE_ME.md"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/include .html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"file"</span> <span class="s">"shortcodes/INCLUDE_ME.md"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Th' included files can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.</p>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Posit'n</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>file</strong></td>
|
||
<td>1</td>
|
||
<td><em><empty></em></td>
|
||
<td>Th' path t' th' file t' be included. Path resolut'n adheres t' <a href="https://gohugo.io/functions/readfile/" target="_blank">Hugo’s build-in <code>readFile</code> funct'n</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>hidefirsthead'n</strong></td>
|
||
<td>2</td>
|
||
<td><code>false</code></td>
|
||
<td>When <code>true</code> an' th' included file contains head'ns, th' first head'n will be hidden. This comes 'n handy, eg. if ye include otherwise standalone Marrrkdown files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="arbitrary-content">Arbitrary Rrrambl'n</h3>
|
||
<div class="wrap-code 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><p>Ye can add standard markdown rules:</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" target="_blank">links</a></li>
|
||
<li>etc.<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></li>
|
||
</ul>
|
||
<div class="wrap-code 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' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)</p>
|
||
</blockquote>
|
||
<div class="footnotes" role="doc-endnotes">
|
||
<hr>
|
||
<ol>
|
||
<li id="fn:1">
|
||
<p>Et Cetera (English: /ɛtˈsɛtərə/), abbreviated t' etc., etc, et cet., be a Latin expression that be used 'n English t' mean “and other similar things”, or “and so forth” <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="math">Math</h1>
|
||
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Arrr! Pirrrates</div>
|
||
<div class="box-content">
|
||
|
||
<p>Fello' pirrrates, grog made us dizzy! Be awarrre <b>some stuff may look weird</b> in this trrranslat'n. Like <b>Merrrmaids</b>, do'n <b>math or chemistrrry</b> and stuff.</p>
|
||
</div>
|
||
</div>
|
||
<p>Th' <code>math</code> shortcode generates beautiful formatted math an' chemical formulae us'n th' <a href="https://mathjax.org/" target="_blank">MathJax</a> library.</p>
|
||
|
||
<span class="math align-center">
|
||
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||
</span>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>This only works 'n modern browsers.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Math codefences (eg. GitHub) an' so yer markdown becomes more port'ble.</p>
|
||
<p>Ye be free t' also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>T' use codefence rules ye have t' turn off <code>guessSyntax</code> fer th' <code>marrrkup.highlight</code> sett'n (<a href="#configuration">see th' configurat'n section</a>).</p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="codefence"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','codefence')"
|
||
>
|
||
<span class="tab-nav-text">codefence</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="codefence"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">```math { align="center" }
|
||
</span></span><span class="line"><span class="cl">$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">math</span> <span class="nx">align</span><span class="p">=</span><span class="s">"center"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">$$\</span><span class="nf">left</span><span class="p">(</span> <span class="err">\</span><span class="nx">sum_</span><span class="p">{</span><span class="nx">k</span><span class="p">=</span><span class="mi">1</span><span class="p">}^</span><span class="nx">n</span> <span class="nx">a_k</span> <span class="nx">b_k</span> <span class="err">\</span><span class="nx">right</span><span class="p">)^</span><span class="mi">2</span> <span class="err">\</span><span class="nx">leq</span> <span class="err">\</span><span class="nf">left</span><span class="p">(</span> <span class="err">\</span><span class="nx">sum_</span><span class="p">{</span><span class="nx">k</span><span class="p">=</span><span class="mi">1</span><span class="p">}^</span><span class="nx">n</span> <span class="nx">a_k</span><span class="p">^</span><span class="mi">2</span> <span class="err">\</span><span class="nx">right</span><span class="p">)</span> <span class="err">\</span><span class="nf">left</span><span class="p">(</span> <span class="err">\</span><span class="nx">sum_</span><span class="p">{</span><span class="nx">k</span><span class="p">=</span><span class="mi">1</span><span class="p">}^</span><span class="nx">n</span> <span class="nx">b_k</span><span class="p">^</span><span class="mi">2</span> <span class="err">\</span><span class="nx">right</span><span class="p">)</span><span class="err">$$</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">math</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/math.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"$$left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"align"</span> <span class="s">"center"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>align</strong></td>
|
||
<td><code>center</code></td>
|
||
<td>Allowed values be <code>left</code>, <code>center</code> or <code>right</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td><em><empty></em></td>
|
||
<td>Yer formuale.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="configuration">Configurat'n</h2>
|
||
<p>MathJax be configured wit' default sett'ns. Ye can cust'mize MathJax’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 MathJax’s configurat'n object.</p>
|
||
<p>See <a href="https://docs.mathjax.org/en/latest/options/index.html" target="_blank">MathJax documentat'n</a> fer all allowed sett'ns.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>T' use codefence rules ye have t' turn off <code>guessSyntax</code> fer th' <code>marrrkup.highlight</code> sett'n.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="global-configuration-file">Global Configurat'n File</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s2">"{ \"chtml\": { \"displayAlign\": \"left\" } }"</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 `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 Merrrmaid an' Math codefences will not work anymore! So this be a</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># mandatory sett'n fer yer ship if ye want t' use Math codefences</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">guessSyntax</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div><h3 id="pages-frontmatter">Page’s Frontmatter</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s2">"{ \"chtml\": { \"displayAlign\": \"left\" } }"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div><h2 id="examples">Examples</h2>
|
||
<h3 id="inline-math">Inline Math</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Inline math be generated if ye use a single <span class="sb">`$`</span> as a delimiter around yer formulae: {{<span class="p"><</span> <span class="nt">math</span> <span class="p">></span>}}$\sqrt{3}${{<span class="p"><</span> <span class="p">/</span><span class="nt">math</span> <span class="p">></span>}}</span></span></code></pre></div><p>Inline math be generated if ye use a single <code>$</code> as a delimiter around yer formulae:
|
||
<span class="math align-center">$\sqrt{3}$</span></p>
|
||
<h3 id="blocklevel-math-with-right-alignment">Blocklevel Math wit' Right Alignment</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">If ye delimit yer formulae by two consecutive <span class="sb">`$$`</span> it generates a new block.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">{{<span class="p"><</span> <span class="nt">math</span> <span class="na">align</span><span class="o">=</span><span class="s">"right"</span> <span class="p">></span>}}
|
||
</span></span><span class="line"><span class="cl">$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||
</span></span><span class="line"><span class="cl">{{<span class="p"><</span> <span class="p">/</span><span class="nt">math</span> <span class="p">></span>}}</span></span></code></pre></div><p>If ye delimit yer formulae by two consecutive <code>$$</code> it generates a new block.</p>
|
||
|
||
<span class="math align-right">
|
||
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||
</span>
|
||
<h3 id="codefence">Codefence</h3>
|
||
<p>Ye can also use codefences.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```math
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"></span>$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
|
||
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
||
<span class="math align-center">$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$</span><h3 id="chemical-formulae">Chemical Formulae</h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">{{<span class="p"><</span> <span class="nt">math</span> <span class="p">></span>}}
|
||
</span></span><span class="line"><span class="cl">$$\ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-}$$
|
||
</span></span><span class="line"><span class="cl">{{<span class="p"><</span> <span class="p">/</span><span class="nt">math</span> <span class="p">></span>}}</span></span></code></pre></div>
|
||
<span class="math align-center">
|
||
$$\ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-}$$
|
||
</span>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="merrrmaid">Merrrmaid</h1>
|
||
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Arrr! Pirrrates</div>
|
||
<div class="box-content">
|
||
|
||
<p>Fello' pirrrates, grog made us dizzy! Be awarrre <b>some stuff may look weird</b> in this trrranslat'n. Like <b>Merrrmaids</b>, do'n <b>math or chemistrrry</b> and stuff.</p>
|
||
</div>
|
||
</div>
|
||
<p>Th' <code>mermaid</code> shortcode generates diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown us'n th' <a href="https://mermaidjs.github.io/" target="_blank">Merrrmaid</a> library.</p>
|
||
|
||
<pre class="mermaid align-center zoomable">
|
||
graph LR;
|
||
If --> Then
|
||
Then --> Else
|
||
</pre>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>This only works 'n modern browsers.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Merrrmaid codefences (eg. GitHub) an' so yer markdown becomes more port'ble.</p>
|
||
<p>Ye be free t' also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>T' use codefence rules ye have t' turn off <code>guessSyntax</code> fer th' <code>marrrkup.highlight</code> sett'n (<a href="#configuration">see th' configurat'n section</a>).</p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="codefence"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','codefence')"
|
||
>
|
||
<span class="tab-nav-text">codefence</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="codefence"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">```mermaid { align="center" zoom="true" }
|
||
</span></span><span class="line"><span class="cl">graph LR;
|
||
</span></span><span class="line"><span class="cl"> If --> Then
|
||
</span></span><span class="line"><span class="cl"> Then --> Else
|
||
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">"center"</span> <span class="nx">zoom</span><span class="p">=</span><span class="s">"true"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">graph</span> <span class="nx">LR</span><span class="p">;</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">If</span> <span class="o">--</span><span class="p">></span> <span class="nx">Then</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Then</span> <span class="o">--</span><span class="p">></span> <span class="nx">Else</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>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/mermaid.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"graph LR;\nIf --> Then\nThen --> Else"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"align"</span> <span class="s">"center"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"zoom"</span> <span class="s">"true"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</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>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>align</strong></td>
|
||
<td><code>center</code></td>
|
||
<td>Allowed values be <code>left</code>, <code>center</code> or <code>right</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>zoom</strong></td>
|
||
<td>see notes</td>
|
||
<td>Whether th' graph be pan- an' zoom'ble.<br><br>If not set th' value be determined by th' <code>mermaidZoom</code> sett'n o' th' <a href="#global-configuration-file">ship</a> or th' <a href="#pages-frontmatter">planks frontmatter</a> or <code>false</code> if not set at all.<br><br>- <code>false</code>: no pan or zoom<br>- <code>true</code>: pan an' zoom active</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td><em><empty></em></td>
|
||
<td>Yer Merrrmaid graph.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<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" target="_blank">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="https://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults" target="_blank">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 cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>T' use codefence rules ye have t' turn off <code>guessSyntax</code> fer th' <code>marrrkup.highlight</code> sett'n.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="global-configuration-file">Global Configurat'n File</h3>
|
||
<div class="wrap-code 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 class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</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 `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 Merrrmaid an' Math codefences will not work anymore! So this be a</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># mandatory sett'n fer yer ship if ye want t' use Merrrmaid codefences</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">guessSyntax</span> <span class="p">=</span> <span class="kc">false</span></span></span></code></pre></div><h3 id="pages-frontmatter">Page’s Frontmatter</h3>
|
||
<div class="wrap-code 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="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span></span></span></code></pre></div><h2 id="examples">Examples</h2>
|
||
<h3 id="flowchart-with-yaml-title">Flowchart wit' YAML-Title</h3>
|
||
<div class="wrap-code 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="o">---</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">title</span><span class="p">:</span> <span class="nx">Example</span> <span class="nx">Diagram</span>
|
||
</span></span><span class="line"><span class="cl"><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>
|
||
<pre class="mermaid align-center zoomable">
|
||
---
|
||
title: Example Diagram
|
||
---
|
||
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]
|
||
</pre>
|
||
<h3 id="sequence-diagram-with-configuration-directive">Sequence Diagram wit' Configurat'n Directive</h3>
|
||
<div class="wrap-code 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="o">%%</span><span class="p">{</span><span class="nx">init</span><span class="p">:{</span><span class="s">"fontFamily"</span><span class="p">:</span><span class="s">"monospace"</span><span class="p">,</span> <span class="s">"sequence"</span><span class="p">:{</span><span class="s">"showSequenceNumbers"</span><span class="p">:</span><span class="kc">true</span><span class="p">}}}</span><span class="o">%%</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">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="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></span><span class="line"><span class="cl"> <span class="nx">John</span><span class="o">-->></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="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="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>
|
||
<pre class="mermaid align-center zoomable">
|
||
%%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%%
|
||
sequenceDiagram
|
||
Alice->>John: Hello John, how be ye?
|
||
loop Healthcheck
|
||
John->>John: Fight against hypochondria
|
||
end
|
||
Note right of John: Rational thoughts!
|
||
John-->>Alice: Great!
|
||
John->>Bob: How about ye?
|
||
Bob-->>John: Jolly bloody!
|
||
</pre>
|
||
<h3 id="class-diagram-with-codefence-syntax">Class Diagram wit' Codefence Rules</h3>
|
||
<div class="wrap-code 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">classDiagram
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal <|-- Duck
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal <|-- Fish
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal <|-- Zebra
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal : +int age
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal : +Str'n gender
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal: +isMammal()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> Animal: +mate()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> class Duck{
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> +Str'n beakColor
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> +swim()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> +quack()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> }
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> class Fish{
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> -int sizeInFeet
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> -canEat()
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> }
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> class Zebra{
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> +bool is_wild
|
||
</span></span></span><span class="line"><span class="cl"><span class="s"> +run()
|
||
</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></code></pre></div>
|
||
<pre class="mermaid align-center zoomable">classDiagram
|
||
Animal <|-- Duck
|
||
Animal <|-- Fish
|
||
Animal <|-- Zebra
|
||
Animal : +int age
|
||
Animal : +Str'n gender
|
||
Animal: +isMammal()
|
||
Animal: +mate()
|
||
class Duck{
|
||
+Str'n beakColor
|
||
+swim()
|
||
+quack()
|
||
}
|
||
class Fish{
|
||
-int sizeInFeet
|
||
-canEat()
|
||
}
|
||
class Zebra{
|
||
+bool is_wild
|
||
+run()
|
||
}</pre><h3 id="state-diagram-aligned-to-the-right">State Diagram Aligned t' th' Right</h3>
|
||
<div class="wrap-code 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">"right"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">stateDiagram</span><span class="o">-</span><span class="nx">v2</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">open</span><span class="p">:</span> <span class="nx">Open</span> <span class="nx">Door</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">closed</span><span class="p">:</span> <span class="nx">Closed</span> <span class="nx">Door</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">locked</span><span class="p">:</span> <span class="nx">Locked</span> <span class="nx">Door</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">open</span> <span class="o">--</span><span class="p">></span> <span class="nx">closed</span><span class="p">:</span> <span class="nx">Close</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">closed</span> <span class="o">--</span><span class="p">></span> <span class="nx">locked</span><span class="p">:</span> <span class="nx">Lock</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">locked</span> <span class="o">--</span><span class="p">></span> <span class="nx">closed</span><span class="p">:</span> <span class="nx">Unlock</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">closed</span> <span class="o">--</span><span class="p">></span> <span class="nx">open</span><span class="p">:</span> <span class="nx">Open</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>
|
||
<pre class="mermaid align-right zoomable">
|
||
stateDiagram-v2
|
||
open: Open Door
|
||
closed: Closed Door
|
||
locked: Locked Door
|
||
open --> closed: Close
|
||
closed --> locked: Lock
|
||
locked --> closed: Unlock
|
||
closed --> open: Open
|
||
</pre>
|
||
<h3 id="entity-relationship-model-with-non-default-mermaid-theme">Entity Relationship Model wit' Non-Default Merrrmaid Theme</h3>
|
||
<div class="wrap-code 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="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">erDiagram</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">CUSTOMER</span> <span class="p">}|..|{</span> <span class="nx">DELIVERY</span><span class="o">-</span><span class="nx">ADDRESS</span> <span class="p">:</span> <span class="nx">has</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">CUSTOMER</span> <span class="o">||--</span><span class="nx">o</span><span class="p">{</span> <span class="nx">ORDER</span> <span class="p">:</span> <span class="nx">places</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">CUSTOMER</span> <span class="o">||--</span><span class="nx">o</span><span class="p">{</span> <span class="nx">INVOICE</span> <span class="p">:</span> <span class="s">"li'ble for"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">DELIVERY</span><span class="o">-</span><span class="nx">ADDRESS</span> <span class="o">||--</span><span class="nx">o</span><span class="p">{</span> <span class="nx">ORDER</span> <span class="p">:</span> <span class="nx">receives</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">INVOICE</span> <span class="o">||--</span><span class="p">|{</span> <span class="nx">ORDER</span> <span class="p">:</span> <span class="nx">covers</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">ORDER</span> <span class="o">||--</span><span class="p">|{</span> <span class="nx">ORDER</span><span class="o">-</span><span class="nx">ITEM</span> <span class="p">:</span> <span class="nx">includes</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">PRODUCT</span><span class="o">-</span><span class="nx">CATEGORY</span> <span class="o">||--</span><span class="p">|{</span> <span class="nx">PRODUCT</span> <span class="p">:</span> <span class="nx">contains</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">PRODUCT</span> <span class="o">||--</span><span class="nx">o</span><span class="p">{</span> <span class="nx">ORDER</span><span class="o">-</span><span class="nx">ITEM</span> <span class="p">:</span> <span class="s">"ordered in"</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>
|
||
<pre class="mermaid align-center zoomable">
|
||
%%{init:{"theme":"forest"}}%%
|
||
erDiagram
|
||
CUSTOMER }|..|{ DELIVERY-ADDRESS : has
|
||
CUSTOMER ||--o{ ORDER : places
|
||
CUSTOMER ||--o{ INVOICE : "li'ble for"
|
||
DELIVERY-ADDRESS ||--o{ ORDER : receives
|
||
INVOICE ||--|{ ORDER : covers
|
||
ORDER ||--|{ ORDER-ITEM : includes
|
||
PRODUCT-CATEGORY ||--|{ PRODUCT : contains
|
||
PRODUCT ||--o{ ORDER-ITEM : "ordered in"
|
||
</pre>
|
||
<h3 id="user-journey">User Journey</h3>
|
||
<div class="wrap-code 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">journey</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="nx">My</span> <span class="nx">work'n</span> <span class="nx">day</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="nx">Go</span> <span class="nx">t'</span> <span class="nx">work</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Make</span> <span class="nx">tea</span><span class="p">:</span> <span class="mi">5</span><span class="p">:</span> <span class="nx">Me</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Go</span> <span class="nx">upstairs</span><span class="p">:</span> <span class="mi">3</span><span class="p">:</span> <span class="nx">Me</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Do</span> <span class="nx">work</span><span class="p">:</span> <span class="mi">1</span><span class="p">:</span> <span class="nx">Me</span><span class="p">,</span> <span class="nx">Cat</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="nx">Go</span> <span class="nx">home</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Go</span> <span class="nx">downstairs</span><span class="p">:</span> <span class="mi">5</span><span class="p">:</span> <span class="nx">Me</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Sit</span> <span class="nx">down</span><span class="p">:</span> <span class="mi">3</span><span class="p">:</span> <span class="nx">Me</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>
|
||
<pre class="mermaid align-center zoomable">
|
||
journey
|
||
title My work'n day
|
||
section Go t' work
|
||
Make tea: 5: Me
|
||
Go upstairs: 3: Me
|
||
Do work: 1: Me, Cat
|
||
section Go home
|
||
Go downstairs: 5: Me
|
||
Sit down: 3: Me
|
||
</pre>
|
||
<h3 id="gantt-chart">GANTT Chart</h3>
|
||
<div class="wrap-code 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">after</span> <span class="nx">des2</span><span class="p">,</span> <span class="mi">5</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Future</span> <span class="nx">task2</span> <span class="p">:</span> <span class="nx">des4</span><span class="p">,</span> <span class="nx">after</span> <span class="nx">des3</span><span class="p">,</span> <span class="mi">5</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">section</span> <span class="nx">Critical</span> <span class="nx">tasks</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Completed</span> <span class="nx">task</span> <span class="nx">'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">after</span> <span class="nx">des1</span><span class="p">,</span> <span class="mi">2</span><span class="nx">d</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Create</span> <span class="nx">tests</span> <span class="k">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>
|
||
<pre class="mermaid align-center zoomable">
|
||
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, after des2, 5d
|
||
Future task2 : des4, after des3, 5d
|
||
section Critical tasks
|
||
Completed task 'n th' critical line :crit, done, 2014-01-06,24h
|
||
Implement parser an' jison :crit, done, after 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
|
||
</pre>
|
||
<h3 id="pie-chart-without-zoom">Pie Chart without Zoom</h3>
|
||
<div class="wrap-code 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">zoom</span><span class="p">=</span><span class="s">"false"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">pie</span> <span class="nx">title</span> <span class="nx">Pets</span> <span class="nx">adopted</span> <span class="nx">by</span> <span class="nx">volunteers</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"Dogs"</span> <span class="p">:</span> <span class="mi">386</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"Cats"</span> <span class="p">:</span> <span class="mi">85</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"Rats"</span> <span class="p">:</span> <span class="mi">15</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>
|
||
<pre class="mermaid align-center">
|
||
pie title Pets adopted by volunteers
|
||
"Dogs" : 386
|
||
"Cats" : 85
|
||
"Rats" : 15
|
||
</pre>
|
||
<h3 id="quadrant-chart">Quadrant Chart</h3>
|
||
<div class="wrap-code 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">pie</span> <span class="nx">title</span> <span class="nx">Pets</span> <span class="nx">adopted</span> <span class="nx">by</span> <span class="nx">volunteers</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="nx">Reach</span> <span class="nx">an'</span> <span class="nx">engagement</span> <span class="nx">o'</span> <span class="nx">campaigns</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">x</span><span class="o">-</span><span class="nx">axis</span> <span class="nx">Low</span> <span class="nx">Reach</span> <span class="o">--</span><span class="p">></span> <span class="nx">High</span> <span class="nx">Reach</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">y</span><span class="o">-</span><span class="nx">axis</span> <span class="nx">Low</span> <span class="nx">Engagement</span> <span class="o">--</span><span class="p">></span> <span class="nx">High</span> <span class="nx">Engagement</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">quadrant</span><span class="o">-</span><span class="mi">1</span> <span class="nx">We</span> <span class="nx">should</span> <span class="nx">expand</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">quadrant</span><span class="o">-</span><span class="mi">2</span> <span class="nx">Need</span> <span class="nx">t'</span> <span class="nx">promote</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">quadrant</span><span class="o">-</span><span class="mi">3</span> <span class="nx">Re</span><span class="o">-</span><span class="nx">evaluate</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">quadrant</span><span class="o">-</span><span class="mi">4</span> <span class="nx">May</span> <span class="nx">be</span> <span class="nx">improved</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">A</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">B</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.45</span><span class="p">,</span> <span class="mf">0.23</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">C</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.57</span><span class="p">,</span> <span class="mf">0.69</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">D</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.78</span><span class="p">,</span> <span class="mf">0.34</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">E</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.40</span><span class="p">,</span> <span class="mf">0.34</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Campaign</span> <span class="nx">F</span><span class="p">:</span> <span class="p">[</span><span class="mf">0.35</span><span class="p">,</span> <span class="mf">0.78</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>
|
||
<pre class="mermaid align-center zoomable">
|
||
quadrantChart
|
||
title Reach an' engagement o' campaigns
|
||
x-axis Low Reach --> High Reach
|
||
y-axis Low Engagement --> High Engagement
|
||
quadrant-1 We should expand
|
||
quadrant-2 Need t' promote
|
||
quadrant-3 Re-evaluate
|
||
quadrant-4 May be improved
|
||
Campaign A: [0.3, 0.6]
|
||
Campaign B: [0.45, 0.23]
|
||
Campaign C: [0.57, 0.69]
|
||
Campaign D: [0.78, 0.34]
|
||
Campaign E: [0.40, 0.34]
|
||
Campaign F: [0.35, 0.78]
|
||
</pre>
|
||
<h3 id="requirement-diagram">Requirement Diagram</h3>
|
||
<div class="wrap-code 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">requirementDiagram</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">requirement</span> <span class="nx">test_req</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">id</span><span class="p">:</span> <span class="mi">1</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">text</span><span class="p">:</span> <span class="nx">th'</span> <span class="nx">test</span> <span class="nx">text</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">risk</span><span class="p">:</span> <span class="nx">high</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">verifymethod</span><span class="p">:</span> <span class="nx">test</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">element</span> <span class="nx">test_entity</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="kd">type</span><span class="p">:</span> <span class="nx">simulat'n</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">test_entity</span> <span class="o">-</span> <span class="nx">satisfies</span> <span class="o">-</span><span class="p">></span> <span class="nx">test_req</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>
|
||
<pre class="mermaid align-center zoomable">
|
||
requirementDiagram
|
||
|
||
requirement test_req {
|
||
id: 1
|
||
text: th' test text.
|
||
risk: high
|
||
verifymethod: test
|
||
}
|
||
|
||
element test_entity {
|
||
type: simulat'n
|
||
}
|
||
|
||
test_entity - satisfies -> test_req
|
||
</pre>
|
||
<h3 id="git-graph">Git Graph</h3>
|
||
<div class="wrap-code 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">gitGraph</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">branch</span> <span class="nx">develop</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">checkout</span> <span class="nx">develop</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">checkout</span> <span class="nx">main</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">merge</span> <span class="nx">develop</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">commit</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>
|
||
<pre class="mermaid align-center zoomable">
|
||
gitGraph
|
||
commit
|
||
commit
|
||
branch develop
|
||
checkout develop
|
||
commit
|
||
commit
|
||
checkout main
|
||
merge develop
|
||
commit
|
||
commit
|
||
</pre>
|
||
<h3 id="c4-diagrams">C4 Diagrams</h3>
|
||
<div class="wrap-code 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">C4Context</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="nx">System</span> <span class="nx">Context</span> <span class="nx">diagram</span> <span class="k">fer</span> <span class="nx">Internet</span> <span class="nx">Bank'n</span> <span class="nx">System</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Enterprise_Boundary</span><span class="p">(</span><span class="nx">b0</span><span class="p">,</span> <span class="s">"BankBoundary0"</span><span class="p">)</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Person</span><span class="p">(</span><span class="nx">customerA</span><span class="p">,</span> <span class="s">"Bank'n Customer A"</span><span class="p">,</span> <span class="s">"A customer o' th' bank, wit' personal bank accounts."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Person</span><span class="p">(</span><span class="nx">customerB</span><span class="p">,</span> <span class="s">"Bank'n Customer B"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Person_Ext</span><span class="p">(</span><span class="nx">customerC</span><span class="p">,</span> <span class="s">"Bank'n Customer C"</span><span class="p">,</span> <span class="s">"desc"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Person</span><span class="p">(</span><span class="nx">customerD</span><span class="p">,</span> <span class="s">"Bank'n Customer D"</span><span class="p">,</span> <span class="s">"A customer o' th' bank, <br/> wit' personal bank accounts."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">System</span><span class="p">(</span><span class="nx">SystemAA</span><span class="p">,</span> <span class="s">"Internet Bank'n System"</span><span class="p">,</span> <span class="s">"Allows customers t' view informat'n about their bank accounts, an' make payments."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Enterprise_Boundary</span><span class="p">(</span><span class="nx">b1</span><span class="p">,</span> <span class="s">"BankBoundary"</span><span class="p">)</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">SystemDb_Ext</span><span class="p">(</span><span class="nx">SystemE</span><span class="p">,</span> <span class="s">"Mainframe Bank'n System"</span><span class="p">,</span> <span class="s">"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">System_Boundary</span><span class="p">(</span><span class="nx">b2</span><span class="p">,</span> <span class="s">"BankBoundary2"</span><span class="p">)</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">System</span><span class="p">(</span><span class="nx">SystemA</span><span class="p">,</span> <span class="s">"Bank'n System A"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">System</span><span class="p">(</span><span class="nx">SystemB</span><span class="p">,</span> <span class="s">"Bank'n System B"</span><span class="p">,</span> <span class="s">"A system o' th' bank, wit' personal bank accounts. next line."</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></span><span class="line"><span class="cl"> <span class="nf">System_Ext</span><span class="p">(</span><span class="nx">SystemC</span><span class="p">,</span> <span class="s">"E-mail system"</span><span class="p">,</span> <span class="s">"The internal Microsoft Exchange e-mail system."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">SystemDb</span><span class="p">(</span><span class="nx">SystemD</span><span class="p">,</span> <span class="s">"Bank'n System D Database"</span><span class="p">,</span> <span class="s">"A system o' th' bank, wit' personal bank accounts."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Boundary</span><span class="p">(</span><span class="nx">b3</span><span class="p">,</span> <span class="s">"BankBoundary3"</span><span class="p">,</span> <span class="s">"boundary"</span><span class="p">)</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">SystemQueue</span><span class="p">(</span><span class="nx">SystemF</span><span class="p">,</span> <span class="s">"Bank'n System F Queue"</span><span class="p">,</span> <span class="s">"A system o' th' bank."</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">SystemQueue_Ext</span><span class="p">(</span><span class="nx">SystemG</span><span class="p">,</span> <span class="s">"Bank'n System G Queue"</span><span class="p">,</span> <span class="s">"A system o' th' bank, wit' personal bank accounts."</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></span><span class="line"><span class="cl"> <span class="nf">BiRel</span><span class="p">(</span><span class="nx">customerA</span><span class="p">,</span> <span class="nx">SystemAA</span><span class="p">,</span> <span class="s">"Uses"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">BiRel</span><span class="p">(</span><span class="nx">SystemAA</span><span class="p">,</span> <span class="nx">SystemE</span><span class="p">,</span> <span class="s">"Uses"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Rel</span><span class="p">(</span><span class="nx">SystemAA</span><span class="p">,</span> <span class="nx">SystemC</span><span class="p">,</span> <span class="s">"Sends e-mails"</span><span class="p">,</span> <span class="s">"SMTP"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">Rel</span><span class="p">(</span><span class="nx">SystemC</span><span class="p">,</span> <span class="nx">customerA</span><span class="p">,</span> <span class="s">"Sends e-mails to"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateElementStyle</span><span class="p">(</span><span class="nx">customerA</span><span class="p">,</span> <span class="err">$</span><span class="nx">fontColor</span><span class="p">=</span><span class="s">"red"</span><span class="p">,</span> <span class="err">$</span><span class="nx">bgColor</span><span class="p">=</span><span class="s">"grey"</span><span class="p">,</span> <span class="err">$</span><span class="nx">borderColor</span><span class="p">=</span><span class="s">"red"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateRelStyle</span><span class="p">(</span><span class="nx">customerA</span><span class="p">,</span> <span class="nx">SystemAA</span><span class="p">,</span> <span class="err">$</span><span class="nx">textColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">lineColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetX</span><span class="p">=</span><span class="s">"5"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateRelStyle</span><span class="p">(</span><span class="nx">SystemAA</span><span class="p">,</span> <span class="nx">SystemE</span><span class="p">,</span> <span class="err">$</span><span class="nx">textColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">lineColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetY</span><span class="p">=</span><span class="s">"-10"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateRelStyle</span><span class="p">(</span><span class="nx">SystemAA</span><span class="p">,</span> <span class="nx">SystemC</span><span class="p">,</span> <span class="err">$</span><span class="nx">textColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">lineColor</span><span class="p">=</span><span class="s">"blue"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetY</span><span class="p">=</span><span class="s">"-40"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetX</span><span class="p">=</span><span class="s">"-50"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateRelStyle</span><span class="p">(</span><span class="nx">SystemC</span><span class="p">,</span> <span class="nx">customerA</span><span class="p">,</span> <span class="err">$</span><span class="nx">textColor</span><span class="p">=</span><span class="s">"red"</span><span class="p">,</span> <span class="err">$</span><span class="nx">lineColor</span><span class="p">=</span><span class="s">"red"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetX</span><span class="p">=</span><span class="s">"-50"</span><span class="p">,</span> <span class="err">$</span><span class="nx">offsetY</span><span class="p">=</span><span class="s">"20"</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">UpdateLayoutConfig</span><span class="p">(</span><span class="err">$</span><span class="nx">c4ShapeInRow</span><span class="p">=</span><span class="s">"3"</span><span class="p">,</span> <span class="err">$</span><span class="nx">c4BoundaryInRow</span><span class="p">=</span><span class="s">"1"</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>
|
||
<pre class="mermaid align-center zoomable">
|
||
C4Context
|
||
title System Context diagram fer Internet Bank'n System
|
||
Enterprise_Boundary(b0, "BankBoundary0") {
|
||
Person(customerA, "Bank'n Customer A", "A customer o' th' bank, wit' personal bank accounts.")
|
||
Person(customerB, "Bank'n Customer B")
|
||
Person_Ext(customerC, "Bank'n Customer C", "desc")
|
||
|
||
Person(customerD, "Bank'n Customer D", "A customer o' th' bank, <br/> wit' personal bank accounts.")
|
||
|
||
System(SystemAA, "Internet Bank'n System", "Allows customers t' view informat'n about their bank accounts, an' make payments.")
|
||
|
||
Enterprise_Boundary(b1, "BankBoundary") {
|
||
|
||
SystemDb_Ext(SystemE, "Mainframe Bank'n System", "Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc.")
|
||
|
||
System_Boundary(b2, "BankBoundary2") {
|
||
System(SystemA, "Bank'n System A")
|
||
System(SystemB, "Bank'n System B", "A system o' th' bank, wit' personal bank accounts. next line.")
|
||
}
|
||
|
||
System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
|
||
SystemDb(SystemD, "Bank'n System D Database", "A system o' th' bank, wit' personal bank accounts.")
|
||
|
||
Boundary(b3, "BankBoundary3", "boundary") {
|
||
SystemQueue(SystemF, "Bank'n System F Queue", "A system o' th' bank.")
|
||
SystemQueue_Ext(SystemG, "Bank'n System G Queue", "A system o' th' bank, wit' personal bank accounts.")
|
||
}
|
||
}
|
||
}
|
||
|
||
BiRel(customerA, SystemAA, "Uses")
|
||
BiRel(SystemAA, SystemE, "Uses")
|
||
Rel(SystemAA, SystemC, "Sends e-mails", "SMTP")
|
||
Rel(SystemC, customerA, "Sends e-mails to")
|
||
|
||
UpdateElementStyle(customerA, $fontColor="red", $bgColor="grey", $borderColor="red")
|
||
UpdateRelStyle(customerA, SystemAA, $textColor="blue", $lineColor="blue", $offsetX="5")
|
||
UpdateRelStyle(SystemAA, SystemE, $textColor="blue", $lineColor="blue", $offsetY="-10")
|
||
UpdateRelStyle(SystemAA, SystemC, $textColor="blue", $lineColor="blue", $offsetY="-40", $offsetX="-50")
|
||
UpdateRelStyle(SystemC, customerA, $textColor="red", $lineColor="red", $offsetX="-50", $offsetY="20")
|
||
|
||
UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
|
||
</pre>
|
||
<h3 id="mindmaps">Mindmaps</h3>
|
||
<div class="wrap-code 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">mindmap</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nf">root</span><span class="p">((</span><span class="nx">mindmap</span><span class="p">))</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Origins</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Long</span> <span class="nx">history</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">::</span><span class="nf">ay'con</span><span class="p">(</span><span class="nx">fa</span> <span class="nx">fa</span><span class="o">-</span><span class="nx">book</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Popularisat'n</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">British</span> <span class="nx">popular</span> <span class="nx">psychology</span> <span class="nx">author</span> <span class="nx">Tony</span> <span class="nx">Buzan</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Research</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">On</span> <span class="nx">effectiveness</span><span class="p"><</span><span class="nx">br</span><span class="o">/</span><span class="p">></span><span class="nx">an'</span> <span class="nx">features</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">On</span> <span class="nx">Automatic</span> <span class="nx">creat'n</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Uses</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Creative</span> <span class="nx">techniques</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Strategic</span> <span class="nx">plann'n</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Argument</span> <span class="nx">mapp'n</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Tools</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Pen</span> <span class="nx">an'</span> <span class="nx">paper</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Merrrmaid</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>
|
||
<pre class="mermaid align-center zoomable">
|
||
mindmap
|
||
root((mindmap))
|
||
Origins
|
||
Long history
|
||
::icon(fa fa-book)
|
||
Popularisat'n
|
||
British popular psychology author Tony Buzan
|
||
Research
|
||
On effectiveness<br/>and features
|
||
On Automatic creat'n
|
||
Uses
|
||
Creative techniques
|
||
Strategic plann'n
|
||
Argument mapp'n
|
||
Tools
|
||
Pen an' paper
|
||
Merrrmaid
|
||
</pre>
|
||
<h3 id="timeline">Timeline</h3>
|
||
<div class="wrap-code 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">timeline</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="nx">History</span> <span class="nx">o'</span> <span class="nx">Social</span> <span class="nx">Media</span> <span class="nx">Platform</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="mi">2002</span> <span class="p">:</span> <span class="nx">LinkedIn</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="mi">2004</span> <span class="p">:</span> <span class="nx">Facebook</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">:</span> <span class="nx">Google</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="mi">2005</span> <span class="p">:</span> <span class="nx">Youtube</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="mi">2006</span> <span class="p">:</span> <span class="nx">Twitter</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>
|
||
<pre class="mermaid align-center zoomable">
|
||
timeline
|
||
title History o' Social Media Platform
|
||
2002 : LinkedIn
|
||
2004 : Facebook
|
||
: Google
|
||
2005 : Youtube
|
||
2006 : Twitter
|
||
</pre>
|
||
<h3 id="sankey">Sankey</h3>
|
||
<div class="wrap-code 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">sankey</span><span class="o">-</span><span class="nx">beta</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="o">%%</span> <span class="nx">source</span><span class="p">,</span><span class="nx">target</span><span class="p">,</span><span class="nx">value</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Electricity</span> <span class="nx">grid</span><span class="p">,</span><span class="nx">Over</span> <span class="nx">generat'n</span> <span class="o">/</span> <span class="nx">exports</span><span class="p">,</span><span class="mf">104.453</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Electricity</span> <span class="nx">grid</span><span class="p">,</span><span class="nx">Heat'n</span> <span class="nx">an'</span> <span class="nx">cool'n</span> <span class="o">-</span> <span class="nx">homes</span><span class="p">,</span><span class="mf">113.726</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Electricity</span> <span class="nx">grid</span><span class="p">,</span><span class="nx">H2</span> <span class="nx">conversion</span><span class="p">,</span><span class="mf">27.14</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>
|
||
<pre class="mermaid align-center zoomable">
|
||
sankey-beta
|
||
|
||
%% source,target,value
|
||
Electricity grid,Over generat'n / exports,104.453
|
||
Electricity grid,Heat'n an' cool'n - homes,113.726
|
||
Electricity grid,H2 conversion,27.14
|
||
</pre>
|
||
<h2 id="xychart">XYChart</h2>
|
||
<div class="wrap-code 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">xychart</span><span class="o">-</span><span class="nx">beta</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">title</span> <span class="s">"Sales Revenue"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">x</span><span class="o">-</span><span class="nx">axis</span> <span class="p">[</span><span class="nx">jan</span><span class="p">,</span> <span class="nx">feb</span><span class="p">,</span> <span class="nx">mar</span><span class="p">,</span> <span class="nx">apr</span><span class="p">,</span> <span class="nx">may</span><span class="p">,</span> <span class="nx">jun</span><span class="p">,</span> <span class="nx">jul</span><span class="p">,</span> <span class="nx">aug</span><span class="p">,</span> <span class="nx">sep</span><span class="p">,</span> <span class="nx">oct</span><span class="p">,</span> <span class="nx">nov</span><span class="p">,</span> <span class="nx">dec</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">y</span><span class="o">-</span><span class="nx">axis</span> <span class="s">"Revenue (in $)"</span> <span class="mi">4000</span> <span class="o">--</span><span class="p">></span> <span class="mi">11000</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">bar</span> <span class="p">[</span><span class="mi">5000</span><span class="p">,</span> <span class="mi">6000</span><span class="p">,</span> <span class="mi">7500</span><span class="p">,</span> <span class="mi">8200</span><span class="p">,</span> <span class="mi">9500</span><span class="p">,</span> <span class="mi">10500</span><span class="p">,</span> <span class="mi">11000</span><span class="p">,</span> <span class="mi">10200</span><span class="p">,</span> <span class="mi">9200</span><span class="p">,</span> <span class="mi">8500</span><span class="p">,</span> <span class="mi">7000</span><span class="p">,</span> <span class="mi">6000</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">line</span> <span class="p">[</span><span class="mi">5000</span><span class="p">,</span> <span class="mi">6000</span><span class="p">,</span> <span class="mi">7500</span><span class="p">,</span> <span class="mi">8200</span><span class="p">,</span> <span class="mi">9500</span><span class="p">,</span> <span class="mi">10500</span><span class="p">,</span> <span class="mi">11000</span><span class="p">,</span> <span class="mi">10200</span><span class="p">,</span> <span class="mi">9200</span><span class="p">,</span> <span class="mi">8500</span><span class="p">,</span> <span class="mi">7000</span><span class="p">,</span> <span class="mi">6000</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>
|
||
<pre class="mermaid align-center zoomable">
|
||
xychart-beta
|
||
title "Sales Revenue"
|
||
x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
|
||
y-axis "Revenue (in $)" 4000 --> 11000
|
||
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
|
||
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
|
||
</pre>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="notice">Notice</h1>
|
||
|
||
|
||
<p>Th' <code>notice</code> shortcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.</p>
|
||
|
||
<div class="box notices cstyle primary">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> There may be pirates</div>
|
||
<div class="box-content">
|
||
|
||
<p>It be all about th' boxes.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"There may be pirates"</span> <span class="nx">ay'con</span><span class="p">=</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">It</span> <span class="nx">be</span> <span class="nx">all</span> <span class="nx">about</span> <span class="nx">th'</span> <span class="nx">boxes</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">primary</span> <span class="s">"There may be pirates"</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">It</span> <span class="nx">be</span> <span class="nx">all</span> <span class="nx">about</span> <span class="nx">th'</span> <span class="nx">boxes</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/notice.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"style"</span> <span class="s">"primary"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"There may be pirates"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"skull-crossbones"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"It be all about th' boxes."</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Posit'n</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td>1</td>
|
||
<td><code>default</code></td>
|
||
<td>Th' style scheme used fer th' box.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td></td>
|
||
<td>see notes</td>
|
||
<td>Th' <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> t' be used. If not set, th' chosen color depends on th' <strong>style</strong>. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n color fer th' severity<br>- fer all other styles: th' correspond'n color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td>2</td>
|
||
<td>see notes</td>
|
||
<td>Arbitrary text fer th' box title. Depend'n on th' <strong>style</strong> there may be a default title. Any given value will overwrite th' default.<br><br>- fer severity styles: th' match'n title fer th' severity<br>- fer all other styles: <em><empty></em><br><br>If ye want no title fer a severity style, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>ay'con</strong></td>
|
||
<td>3</td>
|
||
<td>see notes</td>
|
||
<td><a href="../shortcodes/icon/index.html#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' title. Depend'n on th' <strong>style</strong> there may be a default ay'con. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n ay'con fer th' severity<br>- fer all other styles: <em><empty></em><br><br>If ye want no ay'con fer a severity style, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text t' be displayed 'n box.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="by-severity">By Severity</h3>
|
||
<h4 id="info-with-markup">Ahoi wit' marrrkup</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"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="nx">standard</span> <span class="nx">markdown</span> <span class="nx">rules</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">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">possibilities</span> <span class="nx">be</span> <span class="nf">endless</span> <span class="p">(</span><span class="nx">almost</span> <span class="o">-</span> <span class="nx">includ'n</span> <span class="nx">other</span> <span class="nx">shorrrtcodes</span> <span class="nx">may</span> <span class="nx">or</span> <span class="nx">may</span> <span class="nx">not</span> <span class="nx">work</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle info">
|
||
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Ahoi</div>
|
||
<div class="box-content">
|
||
|
||
<p>An <strong>informat'n</strong> disclaimer</p>
|
||
<p>Ye can add standard markdown rules:</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" target="_blank">links</a></li>
|
||
<li>etc.</li>
|
||
</ul>
|
||
<div class="wrap-code 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' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)</p>
|
||
</blockquote>
|
||
</div>
|
||
</div>
|
||
<h4 id="note">Avast</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"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 class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>notice</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="tip">Smarrrt Arrrse</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"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></code></pre></div>
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Smarrrt Arrrse</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>tip</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="warning">Arrr</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"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 class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Arrr</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>warning</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="warning-with-non-default-title-and-icon">Arrr wit' Non-Default Title an' Ay'con</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Here be dragons"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"dragon"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">warning</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-dragon"></i> Here be dragons</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>warning</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="warning-without-a-title-and-icon">Arrr without a Title an' Ay'con</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"warning"</span> <span class="nx">title</span><span class="p">=</span><span class="s">" "</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">" "</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">warning</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>warning</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="by-brand-colors">By Brand Colors</h3>
|
||
<h4 id="primary-with-title-only">Primary wit' Title only</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Primary"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">primary</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle primary">
|
||
<div class="box-label">Primary</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>primary</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="secondary-with-icon-only">Secondary wit' Ay'con only</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"secondary"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"stopwatch"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">secondary</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-stopwatch"></i></div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>secondary</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="accent">Accent</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"accent"</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">accent</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle accent">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
|
||
<p>An <strong>accent</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="by-color">By Color</h3>
|
||
<h4 id="blue-without-a-title-and-icon">Blue without a Title an' Ay'con</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"blue"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">blue</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle blue">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>blue</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="green-with-title-only">Green wit' Title only</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"green"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Green"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">green</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle green">
|
||
<div class="box-label">Green</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>green</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="grey-with-icon-only">Grey wit' Ay'con only</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"grey"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"bug"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">grey</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle grey">
|
||
<div class="box-label"><i class="fa-fw fas fa-bug"></i></div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>grey</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="orange-with-title-and-icon">Orange wit' Title an' Ay'con</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"orange"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Orange"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"bug"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">orange</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle orange">
|
||
<div class="box-label"><i class="fa-fw fas fa-bug"></i> Orange</div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>orange</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="red-without-a-title-and-icon">Red without a Title an' Ay'con</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"red"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="o">**</span><span class="nx">red</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle red">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
|
||
<p>A <strong>red</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="by-special-color">By Special Color</h3>
|
||
<h4 id="default-with-positional-parameter">Default wit' Positional Parameter</h4>
|
||
<div class="wrap-code 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">Some</span> <span class="nx">serious</span> <span class="nx">informat'n</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle default">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Pay Attent'n t' this Avast!</div>
|
||
<div class="box-content">
|
||
|
||
<p>Some serious informat'n.</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="transparent-with-title-and-icon">Transparent wit' Title an' Ay'con</h4>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">notice</span> <span class="nx">style</span><span class="p">=</span><span class="s">"transparent"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Pay Attent'n t' this Avast!"</span> <span class="nx">ay'con</span><span class="p">=</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">Some</span> <span class="nx">serious</span> <span class="nx">informat'n</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle transparent">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Pay Attent'n t' this Avast!</div>
|
||
<div class="box-content">
|
||
|
||
<p>Some serious informat'n.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="with-user-defined-color-font-awesome-brand-icon-and-markdown-title">Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title</h3>
|
||
<div class="wrap-code 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">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"**Hugo**"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"fab fa-hackerrank"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Victor</span><span class="err">?</span> <span class="nx">Be</span> <span class="nx">it</span> <span class="nx">ye</span><span class="err">?</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">notice</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
|
||
<div class="box notices cstyle default" style="--VARIABLE-BOX-color: fuchsia;">
|
||
<div class="box-label"><i class="fab fa-hackerrank"></i> <strong>Cap'n Hugo</strong></div>
|
||
<div class="box-content">
|
||
|
||
<p>Victor? Be it ye?</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="openapi">OpenAPI</h1>
|
||
|
||
|
||
<p>Th' <code>openapi</code> shortcode uses th' <a href="https://github.com/swagger-api/swagger-ui" target="_blank">Swagger UI</a> library t' display yer OpenAPI / Swagger specificat'ns.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>This only works 'n modern browsers.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">openapi</span> <span class="nx">src</span><span class="p">=</span><span class="s">"https://petstore3.openapi.io/api/v3/openapi.json"</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/openapi.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"src"</span> <span class="s">"https://petstore3.openapi.io/api/v3/openapi.json"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>src</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Th' URL t' th' OpenAPI specificat'n file. This can be relative t' th' URL o' yer plank if it be a leaf or branch bundle.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
|
||
<div class="box-content">
|
||
|
||
<p>If ye want t' print out (or generate a PDF) from yer OpenAPI documentat'n, don’t initiate print'n directly from th' plank because th' elements be optimized fer interactive usage 'n a browser.</p>
|
||
<p>Instead, open th' <a href="../basics/configuration/index.html#activate-print-support">print preview</a> 'n yer browser an' initiate print'n from that plank. This plank be optimized fer read'n an' expands most o' th' avail'ble sections.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="example">Example</h2>
|
||
<h3 id="using-local-file">Us'n Local File</h3>
|
||
<div class="wrap-code 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">openapi</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>
|
||
<div class="sc-openapi-wrapper is-load'n helper-loading-container">
|
||
<div
|
||
class="sc-openapi-container"
|
||
id="R-openapi-e006befa5bc34d38d055c98a5999e152"
|
||
data-openapi-url="../shortcodes/openapi/petstore.json"
|
||
></div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="siteparam">SiteParam</h1>
|
||
|
||
|
||
<p>Th' <code>siteparam</code> shortcode prints values o' ship params.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','shortcode-positional')"
|
||
>
|
||
<span class="tab-nav-text">shortcode (positional)</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="nx">name</span><span class="p">=</span><span class="s">"editURL"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode-positional"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="s">"editURL"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/siteparam.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"name"</span> <span class="s">"editURL"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Posit'n</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>name</strong></td>
|
||
<td>1</td>
|
||
<td><em><empty></em></td>
|
||
<td>Th' name o' th' ship param t' be displayed.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="editurl-from-configtoml"><code>editURL</code> from <code>config.toml</code></h3>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="s">`editURL`</span> <span class="nx">value</span><span class="p">:</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="nx">name</span><span class="p">=</span><span class="s">"editURL"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p><code>editURL</code> value: <a href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/" target="_blank">https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/</a></p>
|
||
<h3 id="nested-parameter-with-markdown-and-html-formatting">Nested parameter wit' Marrrkdown an' HTML formatt'n</h3>
|
||
<p>T' use formatted parameter, add this 'n yer <code>config.toml</code>:</p>
|
||
<div class="wrap-code 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 class="nx">goldmark</span><span class="p">.</span><span class="nx">renderer</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">unsafe</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
||
<div class="tab-panel" data-tab-group="2e49c01844d3fd2bd2d221a6f69afa31">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="configtoml"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('2e49c01844d3fd2bd2d221a6f69afa31','configtoml')"
|
||
>
|
||
<span class="tab-nav-text">config.toml</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="configtoml"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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="p">[</span><span class="nx">params</span><span class="p">.</span><span class="nx">siteparam</span><span class="p">.</span><span class="nx">test</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">text</span> <span class="p">=</span> <span class="s2">"A **nested** parameter <b>with</b> formatting"</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="nx">Formatted</span> <span class="nx">parameter</span><span class="p">:</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="nx">name</span><span class="p">=</span><span class="s">"siteparam.test.text"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div><p>Formatted parameter: A <strong>nested</strong> opt'n <b>with</b> formatt'n</p>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="tab">Tab</h1>
|
||
|
||
|
||
<p>Ye can use a <code>tab</code> shortcode t' display a single tab.</p>
|
||
<p>This be especially useful if ye want t' flag yer code example wit' an explicit language.</p>
|
||
<p>If ye want multiple tabs grouped together ye can wrap yer tabs into th' <a href="../shortcodes/tabs/index.html"><code>tabs</code> shortcode</a>.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="de483cdca33d11e106f2fb2e6d013efd">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="c"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('de483cdca33d11e106f2fb2e6d013efd','c')"
|
||
>
|
||
<span class="tab-nav-text">c</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="c"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="n">printf</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">);</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"c"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```c
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">printf("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></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/tab.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"c"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="p">(</span><span class="s">"```c\nprintf(\"Hello World!\")\n```"</span> <span class="p">|</span> <span class="p">.</span><span class="nx">RenderStr'n</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td>see notes</td>
|
||
<td>Th' style scheme used fer th' tab. If ye don’t set a style an' ye display a single code block inside o' th' tab, its default styl'n will adapt t' that o' a <code>code</code> block. Otherwise <code>default</code> be used.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td>see notes</td>
|
||
<td>Th' <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> t' be used. If not set, th' chosen color depends on th' <strong>style</strong>. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n color fer th' severity<br>- fer all other styles: th' correspond'n color</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td>see notes</td>
|
||
<td>Arbitrary title fer th' tab. Depend'n on th' <strong>style</strong> there may be a default title. Any given value will overwrite th' default.<br><br>- fer severity styles: th' match'n title fer th' severity<br>- fer all other styles: <em><empty></em><br><br>If ye want no title fer a severity style, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>ay'con</strong></td>
|
||
<td>see notes</td>
|
||
<td><a href="../shortcodes/icon/index.html#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' title. Depend'n on th' <strong>style</strong> there may be a default ay'con. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n ay'con fer th' severity<br>- fer all other styles: <em><empty></em><br><br>If ye want no ay'con fer a severity style, ye have t' set this parameter t' <code>" "</code> (a non empty str'n filled wit' spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary text t' be displayed 'n th' tab.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="single-code-block-with-collapsed-margins">Single Code Block wit' Collapsed Margins</h3>
|
||
<div class="wrap-code 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">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Code"</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">printf("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></code></pre></div>
|
||
<div class="tab-panel" data-tab-group="87e7cb1adf9103279908252dc8860f4d">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="code"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('87e7cb1adf9103279908252dc8860f4d','code')"
|
||
>
|
||
<span class="tab-nav-text">Code</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="code"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="n">printf</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">);</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="mixed-markdown-content">Mixed Marrrkdown Rrrambl'n</h3>
|
||
<div class="wrap-code 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">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"_**Mixed**_"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">A</span> <span class="nx">tab</span> <span class="nx">can</span> <span class="nx">not</span> <span class="nx">only</span> <span class="nx">contain</span> <span class="nx">code</span> <span class="nx">but</span> <span class="nx">arbitrary</span> <span class="nx">text</span><span class="p">.</span> <span class="nx">In</span> <span class="nx">this</span> <span class="k">case</span> <span class="nx">text</span> <span class="o">**</span><span class="nx">an'</span><span class="o">**</span> <span class="nx">code</span> <span class="nx">will</span> <span class="nx">get</span> <span class="nx">a</span> <span class="nx">margin</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">printf("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></code></pre></div>
|
||
<div class="tab-panel" data-tab-group="542f694810f42c9dd914130e83563e00">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="mixed"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('542f694810f42c9dd914130e83563e00','mixed')"
|
||
>
|
||
<span class="tab-nav-text"><em><strong>Mixed</strong></em></span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="mixed"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<p>A tab can not only contain code but arbitrary text. In this case text <strong>an'</strong> code will get a margin.</p>
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="n">printf</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">);</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="understanding-style-and-color-behavior">Understand'n <code>style</code> an' <code>color</code> Behavior</h3>
|
||
<p>Th' <code>style</code> parameter affects how th' <code>color</code> parameter be applied.</p>
|
||
<div class="wrap-code 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">title</span><span class="p">=</span><span class="s">"just colored style"</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><span class="line"><span class="cl"><span class="nx">Th'</span> <span class="s">`style`</span> <span class="nx">parameter</span> <span class="nx">be</span> <span class="nx">set</span> <span class="nx">t'</span> <span class="nx">a</span> <span class="nx">color</span> <span class="nx">style</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">This</span> <span class="nx">will</span> <span class="nx">set</span> <span class="nx">th'</span> <span class="nx">background</span> <span class="nx">t'</span> <span class="nx">a</span> <span class="nx">lighter</span> <span class="nx">version</span> <span class="nx">o'</span> <span class="nx">th'</span> <span class="nx">chosen</span> <span class="nx">style</span> <span class="nx">color</span> <span class="nx">as</span> <span class="nx">configured</span> <span class="nx">'n</span> <span class="nx">yer</span> <span class="nx">theme</span> <span class="nx">variant</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">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">title</span><span class="p">=</span><span class="s">"just color"</span> <span class="nx">color</span><span class="p">=</span><span class="s">"blue"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Only</span> <span class="nx">th'</span> <span class="s">`color`</span> <span class="nx">parameter</span> <span class="nx">be</span> <span class="nx">set</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">This</span> <span class="nx">will</span> <span class="nx">set</span> <span class="nx">th'</span> <span class="nx">background</span> <span class="nx">t'</span> <span class="nx">a</span> <span class="nx">lighter</span> <span class="nx">version</span> <span class="nx">o'</span> <span class="nx">th'</span> <span class="nx">chosen</span> <span class="nx">CSS</span> <span class="nx">color</span> <span class="nx">value</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">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">title</span><span class="p">=</span><span class="s">"default style an' color"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"default"</span> <span class="nx">color</span><span class="p">=</span><span class="s">"blue"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Th'</span> <span class="s">`style`</span> <span class="nx">parameter</span> <span class="nx">affects</span> <span class="nx">how</span> <span class="nx">th'</span> <span class="s">`color`</span> <span class="nx">parameter</span> <span class="nx">be</span> <span class="nx">applied</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Th'</span> <span class="s">`default`</span> <span class="nx">style</span> <span class="nx">will</span> <span class="nx">set</span> <span class="nx">th'</span> <span class="nx">background</span> <span class="nx">t'</span> <span class="nx">yer</span> <span class="s">`--MAIN-BG-color`</span> <span class="nx">as</span> <span class="nx">configured</span> <span class="k">fer</span> <span class="nx">yer</span> <span class="nx">theme</span> <span class="nx">variant</span> <span class="nx">resembl'n</span> <span class="nx">th'</span> <span class="k">default</span> <span class="nx">style</span> <span class="nx">but</span> <span class="nx">wit'</span> <span class="nx">different</span> <span class="nx">color</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">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">title</span><span class="p">=</span><span class="s">"just severity style"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Th'</span> <span class="s">`style`</span> <span class="nx">parameter</span> <span class="nx">be</span> <span class="nx">set</span> <span class="nx">t'</span> <span class="nx">a</span> <span class="nx">severity</span> <span class="nx">style</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">This</span> <span class="nx">will</span> <span class="nx">set</span> <span class="nx">th'</span> <span class="nx">background</span> <span class="nx">t'</span> <span class="nx">a</span> <span class="nx">lighter</span> <span class="nx">version</span> <span class="nx">o'</span> <span class="nx">th'</span> <span class="nx">chosen</span> <span class="nx">style</span> <span class="nx">color</span> <span class="nx">as</span> <span class="nx">configured</span> <span class="nx">'n</span> <span class="nx">yer</span> <span class="nx">theme</span> <span class="nx">variant</span> <span class="nx">an'</span> <span class="nx">also</span> <span class="nx">affects</span> <span class="nx">th'</span> <span class="nx">chosen</span> <span class="nx">ay'con</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">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">title</span><span class="p">=</span><span class="s">"severity style an' color"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"info"</span> <span class="nx">color</span><span class="p">=</span><span class="s">"blue"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">Th'</span> <span class="s">`style`</span> <span class="nx">parameter</span> <span class="nx">affects</span> <span class="nx">how</span> <span class="nx">th'</span> <span class="s">`color`</span> <span class="nx">parameter</span> <span class="nx">be</span> <span class="nx">applied</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">This</span> <span class="nx">will</span> <span class="nx">set</span> <span class="nx">th'</span> <span class="nx">background</span> <span class="nx">t'</span> <span class="nx">a</span> <span class="nx">lighter</span> <span class="nx">version</span> <span class="nx">o'</span> <span class="nx">th'</span> <span class="nx">chosen</span> <span class="nx">CSS</span> <span class="nx">color</span> <span class="nx">value</span> <span class="nx">an'</span> <span class="nx">also</span> <span class="nx">affects</span> <span class="nx">th'</span> <span class="nx">chosen</span> <span class="nx">ay'con</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">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>
|
||
<div class="tab-panel" data-tab-group="c322620a9aef0e24bfc987a1bdfdc399">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="just-colored-style"
|
||
class="tab-nav-button tab-panel-style cstyle blue active" tabindex="-1"
|
||
onclick="switchTab('c322620a9aef0e24bfc987a1bdfdc399','just-colored-style')"
|
||
>
|
||
<span class="tab-nav-text">just colored style</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="just-color"
|
||
class="tab-nav-button tab-panel-style cstyle filled" style="--VARIABLE-BOX-color: blue;"
|
||
onclick="switchTab('c322620a9aef0e24bfc987a1bdfdc399','just-color')"
|
||
>
|
||
<span class="tab-nav-text">just color</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="default-style-and-color"
|
||
class="tab-nav-button tab-panel-style cstyle default" style="--VARIABLE-BOX-color: blue;"
|
||
onclick="switchTab('c322620a9aef0e24bfc987a1bdfdc399','default-style-and-color')"
|
||
>
|
||
<span class="tab-nav-text">default style an' color</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="just-severity-stylefa-fw-fas-fa-info-circle"
|
||
class="tab-nav-button tab-panel-style cstyle info"
|
||
onclick="switchTab('c322620a9aef0e24bfc987a1bdfdc399','just-severity-stylefa-fw-fas-fa-info-circle')"
|
||
>
|
||
<span class="tab-nav-text"><i class="fa-fw fas fa-info-circle"></i> just severity style</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="severity-style-and-colorfa-fw-fas-fa-info-circle"
|
||
class="tab-nav-button tab-panel-style cstyle info" style="--VARIABLE-BOX-color: blue;"
|
||
onclick="switchTab('c322620a9aef0e24bfc987a1bdfdc399','severity-style-and-colorfa-fw-fas-fa-info-circle')"
|
||
>
|
||
<span class="tab-nav-text"><i class="fa-fw fas fa-info-circle"></i> severity style an' color</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="just-colored-style"
|
||
class="tab-content tab-panel-style cstyle blue active">
|
||
<div class="tab-content-text">
|
||
|
||
<p>Th' <code>style</code> parameter be set t' a color style.</p>
|
||
<p>This will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant.</p>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="just-color"
|
||
class="tab-content tab-panel-style cstyle filled" style="--VARIABLE-BOX-color: blue;">
|
||
<div class="tab-content-text">
|
||
|
||
<p>Only th' <code>color</code> parameter be set.</p>
|
||
<p>This will set th' background t' a lighter version o' th' chosen CSS color value.</p>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="default-style-and-color"
|
||
class="tab-content tab-panel-style cstyle default" style="--VARIABLE-BOX-color: blue;">
|
||
<div class="tab-content-text">
|
||
|
||
<p>Th' <code>style</code> parameter affects how th' <code>color</code> parameter be applied.</p>
|
||
<p>Th' <code>default</code> style will set th' background t' yer <code>--MAIN-BG-color</code> as configured fer yer theme variant resembl'n th' default style but wit' different color.</p>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="just-severity-stylefa-fw-fas-fa-info-circle"
|
||
class="tab-content tab-panel-style cstyle info">
|
||
<div class="tab-content-text">
|
||
|
||
<p>Th' <code>style</code> parameter be set t' a severity style.</p>
|
||
<p>This will set th' background t' a lighter version o' th' chosen style color as configured 'n yer theme variant an' also affects th' chosen ay'con.</p>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="severity-style-and-colorfa-fw-fas-fa-info-circle"
|
||
class="tab-content tab-panel-style cstyle info" style="--VARIABLE-BOX-color: blue;">
|
||
<div class="tab-content-text">
|
||
|
||
<p>Th' <code>style</code> parameter affects how th' <code>color</code> parameter be applied.</p>
|
||
<p>This will set th' background t' a lighter version o' th' chosen CSS color value an' also affects th' chosen ay'con.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<header class="headline">
|
||
</header>
|
||
<h1 id="tabs">Tabs</h1>
|
||
|
||
|
||
<p>Th' <code>tabs</code> shortcode displays arbitrary rrrambl'n 'n an unlimited number o' tabs.</p>
|
||
<p>This comes 'n handy eg. fer provid'n code snippets fer multiple languages.</p>
|
||
<p>If ye just want a single tab ye can instead call th' <a href="../shortcodes/tab/index.html"><code>tab</code> shortcode</a> standalone.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="a943af608fc5af1ab055a98a08e219ba">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">hello.</div>
|
||
<button
|
||
data-tab-item="py"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('a943af608fc5af1ab055a98a08e219ba','py')"
|
||
>
|
||
<span class="tab-nav-text">py</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="sh"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('a943af608fc5af1ab055a98a08e219ba','sh')"
|
||
>
|
||
<span class="tab-nav-text">sh</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="c"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('a943af608fc5af1ab055a98a08e219ba','c')"
|
||
>
|
||
<span class="tab-nav-text">c</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="py"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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>
|
||
<div
|
||
data-tab-item="sh"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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
|
||
data-tab-item="c"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-c" data-lang="c"><span class="line"><span class="cl"><span class="nf">printf</span><span class="p">(</span><span class="s">"Hello World!"</span><span class="p">);</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.</p>
|
||
<p>See th' <a href="../shortcodes/tab/index.html"><code>tab</code> shortcode</a> fer a descript'n o' th' parameter fer nested tabs.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span class="tab-nav-text">shortcode</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span class="tab-nav-text">partial</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">title</span><span class="p">=</span><span class="s">"hello."</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">title</span><span class="p">=</span><span class="s">"py"</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">title</span><span class="p">=</span><span class="s">"sh"</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">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"c"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="s">```c
|
||
</span></span></span><span class="line"><span class="cl"><span class="s">printf"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></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/tabs.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"hello."</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="p">(</span><span class="nf">slice</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"py"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="p">(</span><span class="s">"```python\nprint(\"Hello World!\")\n```"</span> <span class="p">|</span> <span class="p">.</span><span class="nx">RenderStr'n</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"sh"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="p">(</span><span class="s">"```bash\necho \"Hello World!\"\n```"</span> <span class="p">|</span> <span class="p">.</span><span class="nx">RenderStr'n</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">(</span><span class="nx">dict</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"c"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="p">(</span><span class="s">"```c\nprintf(\"Hello World!\");\n```"</span> <span class="p">|</span> <span class="p">.</span><span class="nx">RenderStr'n</span><span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Default</th>
|
||
<th>Notes</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong>groupid</strong></td>
|
||
<td><em><random></em></td>
|
||
<td>Arbitrary name o' th' group th' tab view belongs t'.<br><br>Tab views wit' th' same <strong>groupid</strong> sychr'nize their selected tab. Th' tab select'n be restored automatically based on th' <code>groupid</code> fer tab view. If th' selected tab can not be found 'n a tab group th' first tab be selected instead.<br><br>This sychronizat'n applies t' th' whole ship!</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>style</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Sets a default value fer every contained tab. Can be overridden by each tab. See th' <a href="../shortcodes/tab/index.html#parameter"><code>tab</code> shortcode</a> fer poss'ble values.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>color</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Sets a default value fer every contained tab. Can be overridden by each tab. See th' <a href="../shortcodes/tab/index.html#parameter"><code>tab</code> shortcode</a> fer poss'ble values.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>title</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary title written 'n front o' th' tab view.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong>ay'con</strong></td>
|
||
<td><em><empty></em></td>
|
||
<td><a href="../shortcodes/icon/index.html#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' title.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><em><strong><content></strong></em></td>
|
||
<td><em><empty></em></td>
|
||
<td>Arbitrary number o' tabs defined wit' th' <code>tab</code> sub-shortcode.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="behavior-of-the-groupid">Behavior o' th' <code>groupid</code></h3>
|
||
<p>See what happens t' th' tab views while ye select different tabs.</p>
|
||
<p>While press'n a tab o' Group A switches all tab views o' Group A 'n sync (if th' tab be available), th' tabs o' Group B be left untouched.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="65b3d296a8668d0d22ad9d11d6f22fed">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="group-a-tab-view-1"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('65b3d296a8668d0d22ad9d11d6f22fed','group-a-tab-view-1')"
|
||
>
|
||
<span class="tab-nav-text">Group A, Tab View 1</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="group-a-tab-view-2"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('65b3d296a8668d0d22ad9d11d6f22fed','group-a-tab-view-2')"
|
||
>
|
||
<span class="tab-nav-text">Group A, Tab View 2</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="group-b"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('65b3d296a8668d0d22ad9d11d6f22fed','group-b')"
|
||
>
|
||
<span class="tab-nav-text">Group B</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="group-a-tab-view-1"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">"a"</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">title</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="p">{{<</span> <span class="nx">highlight</span> <span class="nx">json</span> <span class="s">"linenos=true"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{</span> <span class="s">"Hello"</span><span class="p">:</span> <span class="s">"World"</span> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</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">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">title</span><span class="p">=</span><span class="s">"_**XML**_ stuff"</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">title</span><span class="p">=</span><span class="s">"text"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Hello</span> <span class="nx">World</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></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="group-a-tab-view-2"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">"a"</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">title</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="p">{{<</span> <span class="nx">highlight</span> <span class="nx">json</span> <span class="s">"linenos=true"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{</span> <span class="s">"Hello"</span><span class="p">:</span> <span class="s">"World"</span> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</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">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">title</span><span class="p">=</span><span class="s">"XML stuff"</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">tabs</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="group-b"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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">"b"</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">title</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="p">{{<</span> <span class="nx">highlight</span> <span class="nx">json</span> <span class="s">"linenos=true"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{</span> <span class="s">"Hello"</span><span class="p">:</span> <span class="s">"World"</span> <span class="p">}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">highlight</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">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">title</span><span class="p">=</span><span class="s">"XML stuff"</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">tabs</span> <span class="p">>}}</span></span></span></code></pre></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h4 id="group-a-tab-view-1">Group A, Tab View 1</h4>
|
||
|
||
<div class="tab-panel" data-tab-group="tab-example-a">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="json"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('tab-example-a','json')"
|
||
>
|
||
<span class="tab-nav-text">json</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="xml-stuff"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tab-example-a','xml-stuff')"
|
||
>
|
||
<span class="tab-nav-text"><em><strong>XML</strong></em> stuff</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="text"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tab-example-a','text')"
|
||
>
|
||
<span class="tab-nav-text">text</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="json"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="ln">1</span><span class="cl"><span class="p">{</span> <span class="nt">"Hello"</span><span class="p">:</span> <span class="s2">"World"</span> <span class="p">}</span></span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="xml-stuff"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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>
|
||
<div
|
||
data-tab-item="text"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<pre><code>Hello World
|
||
</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h4 id="group-a-tab-view-2">Group A, Tab View 2</h4>
|
||
|
||
<div class="tab-panel" data-tab-group="tab-example-a">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="json"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('tab-example-a','json')"
|
||
>
|
||
<span class="tab-nav-text">json</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="xml-stuff"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tab-example-a','xml-stuff')"
|
||
>
|
||
<span class="tab-nav-text">XML stuff</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="json"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="ln">1</span><span class="cl"><span class="p">{</span> <span class="nt">"Hello"</span><span class="p">:</span> <span class="s2">"World"</span> <span class="p">}</span></span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="xml-stuff"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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>
|
||
</div>
|
||
</div>
|
||
<h4 id="group-b">Group B</h4>
|
||
|
||
<div class="tab-panel" data-tab-group="tab-example-b">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="json"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('tab-example-b','json')"
|
||
>
|
||
<span class="tab-nav-text">json</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="xml-stuff"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tab-example-b','xml-stuff')"
|
||
>
|
||
<span class="tab-nav-text">XML stuff</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="json"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="ln">1</span><span class="cl"><span class="p">{</span> <span class="nt">"Hello"</span><span class="p">:</span> <span class="s2">"World"</span> <span class="p">}</span></span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="xml-stuff"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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>
|
||
</div>
|
||
</div>
|
||
<h3 id="nested-tab-views-and-color">Nested Tab Views an' Color</h3>
|
||
<p>In case ye want t' nest tab views, th' parent tab that contains nested tab views needs t' be declared wit' <code>{{< tab >}}</code> instead o' <code>{{% tab %}}</code>. Avast, that 'n this case it be not poss'ble t' put markdown 'n th' parent tab.</p>
|
||
<p>Ye can also set style an' color parameter fer all tabs an' overwrite them on tab level. See th' <a href="../shortcodes/tab/index.html#parameter"><code>tab</code> shortcode</a> fer poss'ble values.</p>
|
||
<div class="wrap-code 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">"main"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Rationale"</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">"thumbtack"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Text"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">Simple</span> <span class="nx">text</span> <span class="nx">be</span> <span class="nx">poss'ble</span> <span class="nx">here</span><span class="o">...</span>
|
||
</span></span><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">"tabs-example-language"</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">title</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="nx">Python</span> <span class="nx">be</span> <span class="o">**</span><span class="nx">super</span><span class="o">**</span> <span class="nx">easy</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">most</span> <span class="nx">o'</span> <span class="nx">th'</span> <span class="nx">time</span><span class="p">.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="o">-</span> <span class="k">if</span> <span class="nx">ye</span> <span class="nx">don</span><span class="err">'</span><span class="nx">t</span> <span class="nx">want</span> <span class="nx">t'</span> <span class="nx">output</span> <span class="nx">unicode</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">title</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="nx">Bash</span> <span class="nx">be</span> <span class="k">fer</span> <span class="o">**</span><span class="nx">hackers</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="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><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">tab</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">tab</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Code"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"default"</span> <span class="nx">color</span><span class="p">=</span><span class="s">"darkorchid"</span> <span class="p">>}}</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="o">...</span><span class="nx">but</span> <span class="nx">no</span> <span class="nx">markdown</span>
|
||
</span></span><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">"tabs-example-language"</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">title</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">title</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><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">tab</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>
|
||
<div class="tab-panel" data-tab-group="main">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title"><i class="fa-fw fas fa-thumbtack"></i> Rationale</div>
|
||
<button
|
||
data-tab-item="text"
|
||
class="tab-nav-button tab-panel-style cstyle primary active" tabindex="-1"
|
||
onclick="switchTab('main','text')"
|
||
>
|
||
<span class="tab-nav-text">Text</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="code"
|
||
class="tab-nav-button tab-panel-style cstyle default" style="--VARIABLE-BOX-color: darkorchid;"
|
||
onclick="switchTab('main','code')"
|
||
>
|
||
<span class="tab-nav-text">Code</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="text"
|
||
class="tab-content tab-panel-style cstyle primary active">
|
||
<div class="tab-content-text">
|
||
<p>
|
||
|
||
Simple text be poss'ble here...
|
||
|
||
<div class="tab-panel" data-tab-group="tabs-example-language">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('tabs-example-language','python')"
|
||
>
|
||
<span class="tab-nav-text">python</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="bash"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tabs-example-language','bash')"
|
||
>
|
||
<span class="tab-nav-text">bash</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="python"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<p>Python be <strong>super</strong> easy.</p>
|
||
<ul>
|
||
<li>most o' th' time.</li>
|
||
<li>if ye don’t want t' output unicode</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="bash"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<p>Bash be fer <strong>hackers</strong>.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div
|
||
data-tab-item="code"
|
||
class="tab-content tab-panel-style cstyle default" style="--VARIABLE-BOX-color: darkorchid;">
|
||
<div class="tab-content-text">
|
||
<p>
|
||
|
||
...but no markdown
|
||
|
||
<div class="tab-panel" data-tab-group="tabs-example-language">
|
||
<div class="tab-nav">
|
||
<div class="tab-nav-title">​</div>
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
||
onclick="switchTab('tabs-example-language','python')"
|
||
>
|
||
<span class="tab-nav-text">python</span>
|
||
</button>
|
||
<button
|
||
data-tab-item="bash"
|
||
class="tab-nav-button tab-panel-style cstyle initial"
|
||
onclick="switchTab('tabs-example-language','bash')"
|
||
>
|
||
<span class="tab-nav-text">bash</span>
|
||
</button>
|
||
</div>
|
||
<div class="tab-content-container">
|
||
<div
|
||
data-tab-item="python"
|
||
class="tab-content tab-panel-style cstyle initial active">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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>
|
||
<div
|
||
data-tab-item="bash"
|
||
class="tab-content tab-panel-style cstyle initial">
|
||
<div class="tab-content-text">
|
||
|
||
<div class="wrap-code 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>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
</section>
|
||
</div>
|
||
</main>
|
||
</div>
|
||
<script src="../js/clipboard.min.js?1700353946" defer></script>
|
||
<script src="../js/perfect-scrollbar.min.js?1700353946" defer></script>
|
||
<script>
|
||
function useMathJax( config ){
|
||
if( !Object.assign ){
|
||
|
||
return;
|
||
}
|
||
window.MathJax = Object.assign( window.MathJax || {}, {
|
||
loader: {
|
||
load: ['[tex]/mhchem']
|
||
},
|
||
startup: {
|
||
elements: [
|
||
'.math'
|
||
]
|
||
},
|
||
tex: {
|
||
inlineMath: [
|
||
['$', '$'],
|
||
['\\(', '\\)']
|
||
]
|
||
},
|
||
options: {
|
||
enableMenu: false
|
||
}
|
||
}, config );
|
||
}
|
||
useMathJax( JSON.parse("{}") );
|
||
</script>
|
||
<script id="MathJax-script" async src="../js/mathjax/tex-mml-chtml.js?1700353946"></script>
|
||
<script src="../js/d3/d3-color.min.js?1700353946" defer></script>
|
||
<script src="../js/d3/d3-dispatch.min.js?1700353946" defer></script>
|
||
<script src="../js/d3/d3-drag.min.js?1700353946" defer></script>
|
||
<script src="../js/d3/d3-ease.min.js?1700353946" defer></script>
|
||
<script src="../js/d3/d3-interpolate.min.js?1700353946" defer></script>
|
||
<script src="../js/d3/d3-selection.min.js?1700353946" defer></script>
|
||
<script src="../js/d3/d3-timer.min.js?1700353946" defer></script>
|
||
<script src="../js/d3/d3-transition.min.js?1700353946" defer></script>
|
||
<script src="../js/d3/d3-zoom.min.js?1700353946" defer></script>
|
||
<script src="../js/js-yaml.min.js?1700353946" defer></script>
|
||
<script src="../js/mermaid.min.js?1700353946" defer></script>
|
||
<script>
|
||
window.themeUseMermaid = JSON.parse("{ \"securityLevel\": \"loose\" }");
|
||
</script>
|
||
<script>window.noZensmooth = true;</script>
|
||
<script src="../js/swagger-ui/swagger-ui-bundle.js?1700353946" defer></script>
|
||
<script src="../js/swagger-ui/swagger-ui-standalone-preset.js?1700353946" defer></script>
|
||
<script>
|
||
window.themeUseOpenapi = { css: "/js/swagger-ui/swagger-ui.css?1700353946", assetsBuster: 1700353946 };
|
||
</script>
|
||
<script src="../js/theme.js?1700353946" defer></script>
|
||
</body>
|
||
</html>
|