<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>
<p><ahref="#R-image-2d701b8f5afa66dd1594b4eda40f8d08"class="lightbox-link"><imgsrc="../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>
<ahref="javascript:history.back();"class="lightbox-back"id="R-image-2d701b8f5afa66dd1594b4eda40f8d08"><imgsrc="../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>
<p>Th' theme be a fork o' th' great <ahref="https://github.com/matcornic/hugo-theme-learn"target="_blank">Learrrn theme</a> wit' th' aim o' fix'n long outstand'n bugs an' adept'n t' latest Cap'n Hugo features. As far as poss'ble this theme tries t' be a drop-in replacement fer th' Learrrn theme.</p>
<li><ahref="../basics/configuration/#serving-your-page-from-the-filesystem">Us'ble from yer local file system via <code>file://</code> protocol</a></li>
<li>Support fer th' <ahref="https://github.com/estruyf/vscode-front-matter"target="_blank">VSCode Front Matter extension</a> fer on-premise CMS capabilities</li>
<p>T' get support, feel free t' open a new <ahref="https://github.com/McShelby/hugo-theme-relearn/discussions"target="_blank">discussion topic</a> or <ahref="https://github.com/McShelby/hugo-theme-relearn/issues"target="_blank">issue report</a> 'n th' official repository on GitHub.</p>
<p>Ye be most welcome t' contribute bugfixes or new features by mak'n pull requests t' th' <ahref="https://github.com/McShelby/hugo-theme-relearn"target="_blank">official repository</a>. Check th' <ahref="../dev/contributing/">contribut'n guidelines</a> first before start'n.</p>
<p>Th' Relearrrn theme be licensed under th' <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE"target="_blank">MIT License</a>.</p>
<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>
<p>This document shows ye what’s new 'n th' latest release. For a detailed list o' changes, see th' <ahref="../basics/history/">history plank</a>.</p>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> A change 'n default behavior that may requires act'n by ye if ye want t' revert it.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Marks new behavior ye might find interest'n or comes configur'ble.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> It be now poss'ble t' print custom taxonomies anywhere 'n ye plank. <ahref="../cont/taxonomy/#customization">See th' docs</a>.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> It be now poss'ble t' adjust th' menu width fer yer whole ship. <ahref="../basics/customization/#change-the-menu-width">See th' docs</a>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' theme now provides a mechanism t' board further JavaScript dependencies defined by ye. This comes 'n handy if ye want t' add yer own shorrrtcodes that require additional JavaScript code t' be boarded. <ahref="../basics/customization/#own-shortcodes-with-javascript-dependencies">See th' docs</a>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> This release adds social media meta tags fer th' Open Graph protocol an' Twitter Cards t' yer ship. <ahref="../basics/configuration/#social-media-meta-tags">See th' docs</a>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> This release comes wit' additional sort opt'ns fer th' menu an' th' <ahref="../shortcodes/children/"><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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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 <ahref="../cont/pages/#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><ahref="../cont/menushortcuts/#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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' output o' th' dedicated search plank now displays th' result’s breadcrumb.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> T'ble rows now change their background color on every even row.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translat'n into Swahili. This language be not supported fer search.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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><ahref="../basics/customization/">partial overridden</a>, ye may want t' review th' styl'n (eg. margins/paddings) o' yer partial.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <ahref="../basics/topbar/">th' documentat'n</a> fer further details.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' theme has updated its Swagger dependency t' 5.7.2 fer th' <ahref="../shortcodes/openapi/"><code>openapi</code> shortcode</a>. This br'ns support fer OpenAPI Specificat'n 3.1.</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><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' default values fer th' <ahref="../cont/markdown/#image-effects">image effects</a> be <ahref="../cont/imageeffects/">now configur'ble</a> fer yer whole ship via <code>config.toml</code> or fer each plank thru frontmatter.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Restored compatibility wit' Cap'n Hugo versions lower than <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.111.0</span></span> fer th' <ahref="../shortcodes/highlight/"><code>highlight</code> shortcode</a>. This does not change th' minimum required Cap'n Hugo version.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' <ahref="../shortcodes/highlight/"><code>highlight</code> shortcode</a> now accepts th' new parameter <code>title</code>. This displays th' code like a <ahref="../shortcodes/tab/">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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' theme now <ahref="../basics/customization/#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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' theme has updated its Merrrmaid dependency t' 10.3.1. This adds support fer th' <ahref="../shortcodes/mermaid/#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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translat'n into Hungarian.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Restored compatibility wit' Cap'n Hugo <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' <ahref="../shortcodes/siteparam/"><code>siteparam</code> shortcode</a> be now cap'ble 'n display'n nested params aswell as support'n text formatt'n.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Restored compatibility wit' Cap'n Hugo <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' new <ahref="../shortcodes/highlight/"><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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Th' 404 error plank was revamped. Hopefully ye will not see this very often.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' <ahref="../shortcodes/tabs/"><code>tabs</code> shortcode</a> an' th' <ahref="../shortcodes/tab/"><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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' theme now optionally supports <ahref="../basics/customization/#change-the-favicon">separate favicons</a> fer light & dark mode.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Restored compatibility wit' Cap'n Hugo <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="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' <ahref="../shortcodes/attachments/"><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 <ahref="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Th' <ahref="../shortcodes/tabs/"><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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' already known <code>tabs</code>has a new friend th' <ahref="../shortcodes/tab/"><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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Besides th' <em>tag</em><ahref="../cont/taxonomy/">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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <ahref="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Th' <code>swagger</code> shortcode was deprecated 'n favor fer th' <ahref="../shortcodes/openapi/"><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' <ahref="https://github.com/swagger-api/swagger-ui"target="_blank">SwaggerUI</a>.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Support fer th' great <ahref="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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' <ahref="../pir/basics/migration/">pirate translat'n</a>. This feature be not avail'ble 'n Internet Explorer 11.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' scrollbars be now colored accord'n t' their variant color scheme t' better fit into th' visuals.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Th' theme removed th' popular <ahref="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span><ahref="../shortcodes/mermaid/#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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Th' JavaScript code fer handl'n image lightboxes (provided by <ahref="https://noelboss.github.io/featherlight"target="_blank">Featherlight</a>) was replaced by a CSS-only solut'n.</p>
<p>This also changed th' <ahref="../cont/markdown/#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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' <ahref="../shortcodes/expand/"><code>expand</code> shortcode</a> was changed. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translat'n into Czech. This language be not supported fer search.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span><ahref="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' <ahref="../shortcodes/attachments/"><code>attachments</code></a>, <ahref="../shortcodes/badge/"><code>badge</code></a>, <ahref="../shortcodes/button/"><code>button</code></a> an' <ahref="../shortcodes/notice/"><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>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>Make th' plank file a <ahref="https://gohugo.io/content-management/age-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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="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><spanclass="line"><spanclass="cl"><spanclass="nx">publishResources</span><spanclass="p">=</span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Th' required folder name fer th' <ahref="../shortcodes/attachments/"><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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' new <ahref="../shortcodes/badge/"><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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' new <ahref="../shortcodes/icon/"><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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' <ahref="../shortcodes/button/"><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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' search now supports th' Korean language.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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' <ahref="../basics/configuration/#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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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' <ahref="../basics/configuration/#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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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' <ahref="../cont/markdown/#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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span><ahref="../basics/configuration/#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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Th' <ahref="../shortcodes/button/"><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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' <ahref="../shortcodes/math/"><code>math</code> shortcode</a> an' <ahref="../shortcodes/mermaid/"><code>mermaid</code> shortcode</a> now also support th' <code>align</code> parameter if codefence rules be used.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translat'n into Finnish (Suomi).</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span><ahref="../cont/markdown/#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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Print'n fer th' <ahref="../shortcodes/openapi/"><code>swagger</code> shortcode</a> was optimized t' expand sections that be usually closed 'n interactive mode. This requires <ahref="../basics/configuration/#activate-print-support">print support</a> t' be configured.</p>
<li><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.95.0</span></span> This release requires a newer Cap'n Hugo version.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Th' way <ahref="../cont/archetypes/">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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' new shortcode <code>math</code> be avail'ble t' add beautiful math an' chemical formulae. See th' <ahref="../shortcodes/math/">documentat'n</a> fer avail'ble features. This feature will not work wit' Internet Explorer 11.</p>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Break'n</span></span> Th' second parameter fer th' <ahref="../shortcodes/include/"><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><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Previously, if th' <ahref="../shortcodes/tabs/"><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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> While fix'n issues wit' th' search functionality fer non Latin languages, ye can now <ahref="../cont/i18n/#search-with-mixed-language-support">configure t' have multiple languages on a single plank</a>.</li>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' <ahref="../shortcodes/button/"><code>button</code></a> shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translat'n into Polish. This language be not supported fer search.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' documentat'n fer all shorrrtcodes were revised.</p>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Ye can activate <ahref="../basics/configuration/#activate-print-support">print support</a> 'n yer <code>config.toml</code> t' add th' capability t' print whole chapters or even th' complete ship.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translat'n into Traditional Chinese.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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' <ahref="../basics/generator/">theme variant generator</a> o' th' exampleSite fer all avail'ble variables.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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' <ahref="../shortcodes/openapi/">documentat'n</a> fer avail'ble features. This feature will not work wit' Internet Explorer 11.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.93.0</span></span> This release requires a newer Cap'n Hugo version.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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' <ahref="../basics/generator/">theme variant generator</a> o' th' exampleSite fer an example.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span><ahref="../shortcodes/attachments/"><code>attachment</code></a> an' <ahref="../shortcodes/notice/"><code>notice</code></a> shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all <ahref="https://fontawesome.com/v5/search?m=free"target="_blank">Font Awesome 5 Free</a> ay'cons.</li>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Break'n</span></span> We made changes t' th' menu footer. If ye have yer <code>menu-footer.html</code><ahref="../basics/customization/">partial overridden</a>, ye may have t' review th' styl'n (eg. margins/paddings) 'n yer partial. For a reference take a look into th' <code>menu-footer.html</code> partial that be com'n wit' th' exampleSite.</p>
<p>This change was made t' allow yer own menu footer t' be placed right after th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' <em>Clear history</em> functionality).</p>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>. <ahref="../basics/customization/#theme-variant">If ye still want t' use th' Learrrn color variant</a>, ye have t' explicitly set <code>themeVariant="learn"</code> 'n yer <code>config.toml</code>.</p>
<p>Avast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <ahref="../basics/customization/#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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive <ahref="../basics/generator/">theme variant generator</a>. This feature will not work wit' Internet Explorer 11.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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' <ahref="../basics/customization/#multiple-variants">documentat'n</a> fer configurat'n.</p>
<p>Avast, that th' new variant switch will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant switcher will not be displayed wit' Internet Explorer 11.</p>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<p>If you’ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but <ahref="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 <ahref="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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-sh"data-lang="sh"><spanclass="line"><spanclass="cl">ERROR 2021/11/19 22:29:10 <spanclass="o">[</span>en<spanclass="o">]</span> REF_NOT_FOUND: Ref <spanclass="s2">"basics/configuration/_index.md"</span>: <spanclass="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>
<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>
<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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <ahref="../basics/customization/#change-the-favicon">out o' th' box</a>. An overridden partial <code>layouts/partials/favicon.html</code> may not be necessary anymore 'n most cases.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <ahref="../basics/configuration/#global-site-parameters">th' example configurat'n</a>.</p>
<li><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Optional second parameter fer <ahref="../shortcodes/notice/"><code>notice</code></a> shortcode t' set title 'n box header.</li>
<li><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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' <ahref="../basics/configuration/#a-word-on-running-your-site-in-a-subfolder">documentat'n</a> fer a detailed example.</li>
<li><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <ahref="../cont/pages/#override-expand-state-rules-for-menu-entries">documentat'n</a> fer poss'ble values an' default behavior.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See <ahref="https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head"target="_blank">Cap'n Hugo documentat'n</a>.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.81.0</span></span> This release requires a newer Cap'n Hugo version.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.69.0</span></span> This release requires a newer Cap'n Hugo version.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> If a search term be found 'n an <code>expand</code> shortcode, th' expand will be opened.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Th' menu will scroll th' active item into view on board.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Rules highlight'n was switched t' th' <ahref="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> A plank without a <code>title</code> will be treated as <code>hidden=true</code>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further <ahref="../cont/pages/#override-expand-state-rules-for-menu-entries">documentat'n</a> fer poss'ble values an' default behavior.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See <ahref="../basics/customization/">documentat'n</a> fer further read'n.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> New shortcode <ahref="../shortcodes/include/"><code>include</code></a> t' include arbitrary file rrrambl'n into a plank.</p>
<li><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Shortcode <ahref="../shortcodes/expand/"><code>expand</code></a> wit' new parameter t' open on plank board.</li>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Break'n</span></span><ahref="../shortcodes/mermaid/">Merrrmaid</a> diagrams can now be panned an' zoomed. This isn’t configur'ble yet.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span><ahref="../shortcodes/mermaid/#configuration"><code>Merrrmaid</code></a> config opt'ns can be set 'n <code>config.toml</code>.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Initial fork o' th' <ahref="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 <ahref="https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495"target="_blank">this comment</a> 'n th' Learrrn issues.</p>
<p>Just download at least version <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.95.0</span></span> o' th' <ahref="https://gohugo.io/getting-started/installing/"target="_blank">Cap'n Hugo binary</a> fer yer OS (Windows, Linux, Mac).</p>
<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 <ahref="https://gohugo.io/overview/quickstart/"target="_blank">great documentat'n fer beginners</a>.</p>
<p>Alternatively, ye can <ahref="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>
<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 <ahref="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>
<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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">home</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"HTML"</span><spanclass="p">,</span><spanclass="s2">"RSS"</span><spanclass="p">,</span><spanclass="s2">"SEARCH"</span><spanclass="p">]</span></span></span></code></pre></div><h2id="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>
</span></span><spanclass="line"><spanclass="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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="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>
<h2id="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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new basics/first-content.md
</span></span><spanclass="line"><spanclass="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>
<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>
<h2id="build-the-website">Build th' website</h2>
<p>When yer ship be ready t' deploy, run th' follow'n command:</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="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>
<p>This website can be automatically published an' hosted wit' <ahref="https://www.netlify.com/"target="_blank">Netlify</a> (Read more about <ahref="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 <ahref="https://gohugo.io/hosting-and-deployment/hosting-on-github/"target="_blank">GitHub planks</a>.</p>
<p>On top o' <ahref="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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># This controls whether submenus will be expanded (true), or collapsed (false) 'n th'</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># menu; if no sett'n be given, th' first menu level be set t' false, all others t' true;</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># this can be overridden 'n th' planks frontmatter</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Prefix URL t' edit current plank. Will display an "Edit" button on top right hand corner o' every plank.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Useful t' give opportunity t' people t' create merge request fer yer doc.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># See th' config.toml file from this documentat'n ship t' have an example.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Disables hidden planks from show'n up 'n th' sitemap an' on Google (et all), otherwise they may be indexed by search engines</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Disables hidden planks from show'n up on th' tags plank although th' tag term will be displayed even if all planks be hidden</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Javascript an' CSS cache be automatically busted when new version o' ship be generated.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Set this t' true t' dis'ble this behavior (some proxies don't handle well this optimization)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Set this t' true if ye want t' dis'ble generat'n fer generator version meta tags o' hugo an' th' theme;</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># don't forget t' also set Hugo's disableHugoGeneratorInject=true, otherwise it will generate a meta tag into yer home plank</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Set this t' true t' dis'ble th' hover effect fer copy-to-clipboard buttons fer block code.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># A title fer shortcuts 'n menu be set by default. Set this t' true t' dis'ble it.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set t' false, a Home button will appear below th' search bar on th' menu.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># It be redirect'n t' th' land'n plank o' th' current language if specified. (Default be "/")</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set t' false, board th' MathJax module on every plank regardless if a MathJax shortcode be present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set t' false, board th' Merrrmaid module on every plank regardless if a Merrrmaid shortcode or Merrrmaid codefence be present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set t' false, board th' OpenAPI module on every plank regardless if a OpenAPI shortcode be present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Change default color scheme wit' a variant one. Eg. can be "auto", "red", "blue", "green" or an array like [ "blue", "green" ].</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="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><spanclass="line"><spanclass="cl"><spanclass="c"># If set t' true, no index.html will be appended t' prettyURLs; this will cause planks not</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># t' be serv'ble from th' file system</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># For external links ye can define how they be opened 'n yer browser; this sett'n will only be applied t' th' rrrambl'n area but not th' shortcut menu</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Override default values fer image effects, ye can even add yer own arbitrary effects t' th' list</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">shadow</span><spanclass="p">=</span><spanclass="kc">false</span></span></span></code></pre></div><h2id="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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">relativeURLs</span><spanclass="p">=</span><spanclass="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 <ahref="https://github.com/gohugoio/hugo/issues/5226"target="_blank">https://github.com/gohugoio/hugo/issues/5226</a>.</p>
<h2id="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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="nx">relativeURLs</span><spanclass="p">=</span><spanclass="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>
<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><ahref="#activate-search">as seen below</a>.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">home</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"HTML"</span><spanclass="p">,</span><spanclass="s2">"RSS"</span><spanclass="p">,</span><spanclass="s2">"SEARCH"</span><spanclass="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>
<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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">home</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"HTML"</span><spanclass="p">,</span><spanclass="s2">"RSS"</span><spanclass="p">,</span><spanclass="s2">"SEARCH"</span><spanclass="p">,</span><spanclass="s2">"SEARCHPAGE"</span><spanclass="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>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>
<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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">plank</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"HTML"</span><spanclass="p">,</span><spanclass="s2">"RSS"</span><spanclass="p">,</span><spanclass="s2">"PRINT"</span><spanclass="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>
<p>Th' result'n URL will not be <ahref="https://gohugo.io/templates/output-formats/#configure-output-formats"target="_blank">configured ugly</a> 'n terms o' <ahref="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>
<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 <ahref="../shortcodes/math/">Math</a> fer additional documentat'n.</p>
<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>
<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 <ahref="../shortcodes/mermaid/">Merrrmaid</a> fer additional documentat'n.</p>
<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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p">...</span></span></span></code></pre></div><p>If those params be not configured fer a specific language, they will get their
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="nx">landingPageName</span><spanclass="p">=</span><spanclass="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>Ye can add social media meta tags fer th' <ahref="https://gohugo.io/templates/internal/#open-graph"target="_blank">Open Graph</a> protocol an' <ahref="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>
<p>Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple <ahref="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 <ahref="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>
<li><code>header.html</code>: th' header o' th' plank. See <ahref="#output-formats">output-formats</a></li>
<li><code>footer.html</code>: th' footer o' th' plank. See <ahref="#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 <ahref="#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 <ahref="#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>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>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>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>
<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>
<p>IE an' old browser versions do not support <ahref="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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">link</span><spanclass="na">rel</span><spanclass="o">=</span><spanclass="s">"icon"</span><spanclass="na">href</span><spanclass="o">=</span><spanclass="s">"/images/favicon.bmp"</span><spanclass="na">type</span><spanclass="o">=</span><spanclass="s">"image/bmp"</span><spanclass="p">></span></span></span></code></pre></div><h2id="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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">themeVariant</span><spanclass="p">=</span><spanclass="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>
<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>
<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 <ahref="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>
<h3id="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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">themeVariant</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"auto"</span><spanclass="p">,</span><spanclass="s2">"red"</span><spanclass="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>
<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>
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="c1"></span><spanclass="p">});</span></span></span></code></pre></div><h3id="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' <ahref="../basics/generator/">interactive variant generator</a>.</p>
<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>
<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>
<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>
<p>Certain parts o' th' theme can be changed fer support o' yer own <ahref="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>
<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>
<p><ahref="#R-image-5e9a5265fc03f772771135339a4a5424"class="lightbox-link"><imgsrc="../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>
<ahref="javascript:history.back();"class="lightbox-back"id="R-image-5e9a5265fc03f772771135339a4a5424"><imgsrc="../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>
<li><ahref="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><ahref="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><ahref="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'
<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>
<h2id="buttons">Buttons</h2>
<p>Th' theme ships wit' th' follow'n predefined buttons (from left t' right 'n th' screenshot)</p>
</span><ahref="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>
</span><ahref="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>
</span><ahref="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>
</span><ahref="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>
<p>Not all buttons be displayed at every given time. This be configur'ble (see below if interested).</p>
<h2id="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 <ahref="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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p">)}}</span></span></span></code></pre></div><h2id="defining-own-buttons">Defin'n own Buttons</h2>
<h3id="button-types">Button Types</h3>
<p>Th' theme distingushies between two types o' buttons:</p>
<li><ahref="#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>
<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>
<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>
<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 <ahref="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 <ahref="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 <ahref="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>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>
<p>Contains th' basic button functionality an' be used as a base implementat'n fer all other buttons (<ahref="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 (<ahref="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 (<ahref="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>
<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>
<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>
<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>
<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 (<ahref="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>
<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>
<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>
<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>
<p>Th' predefined buttons by th' theme that open an overlay (the <em>more</em> an' <em>toc</em> button 'n <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button"target="_blank"><code>layouts/partials/topbar/button</code></a>).</p>
<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>
<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>
<li>[<strong>feature</strong>] math: hide unrendered math <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/662"target="_blank">#662</a></li>
<li>[<strong>bug</strong>] variant: fix sidebar-flyout borders color fer zen <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/661"target="_blank">#661</a></li>
<li>[<strong>bug</strong>] clipboard: ignore RTL fer code <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/660"target="_blank">#660</a></li>
<li>[<strong>bug</strong>] theme: fix id generat'n fer markdownified titles <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/656"target="_blank">#656</a></li>
<li>[<strong>bug</strong>] mermaid: fix width fer some graphs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/655"target="_blank">#655</a></li>
<li>[<strong>feature</strong>] markdown: add interlace color fer tables <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/648"target="_blank">#648</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] menu: optionally dis'ble index planks fer sections <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/642"target="_blank">#642</a></li>
<li>[<strong>bug</strong>][<strong>change</strong>] theme: avoid id collisions between head'ns an' theme <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/646"target="_blank">#646</a></li>
<li>[<strong>bug</strong>] theme: remove HTML validat'n errors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/644"target="_blank">#644</a></li>
<li>[<strong>bug</strong>] breadcrumb: remove superflous whitespace between items <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/643"target="_blank">#643</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: support fer colored borders between menu an' rrrambl'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/626"target="_blank">#626</a></li>
<li>[<strong>bug</strong>] highlight: fix render'n fer Cap'n Hugo < 0.111 <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/618"target="_blank">#618</a></li>
<li>[<strong>bug</strong>] variant: minor adjustments t' zen variants <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/187"target="_blank">#187</a></li>
<li>[<strong>feature</strong>] highlight: add title parameter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/616"target="_blank">#616</a></li>
<li>[<strong>feature</strong>] variant: signal variant switch as event <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/613"target="_blank">#613</a></li>
<li>[<strong>bug</strong>] siteparam: avoid halt if param be a map/slice <ahref="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 <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/605"target="_blank">#605</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] shorrrtcodes: add more deprecat'n warnings <ahref="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 <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/581"target="_blank">#581</a></li>
<li>[<strong>bug</strong>] openapi: inherit RTL sett'n from Cap'n Hugo rrrambl'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/600"target="_blank">#600</a></li>
<li>[<strong>bug</strong>] 404: fix display 'n RTL <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/594"target="_blank">#594</a></li>
<li>[<strong>bug</strong>] search: fix typo 'n output format <ahref="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 <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/577"target="_blank">#577</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] highlight: make copy t' clipboard appear on hover <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/574"target="_blank">#574</a></li>
<li>[<strong>bug</strong>] theme: support Cap'n Hugo 0.114.0 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/573"target="_blank">#573</a></li>
<li>[<strong>bug</strong>] taxonomy: fix number tags <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/570"target="_blank">#570</a></li>
<li>[<strong>bug</strong>] mermaid: allow fer YAML frontmatter inside o' graph <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/562"target="_blank">#562</a></li>
<li>[<strong>feature</strong>] tabs: support color opt'ns <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/549"target="_blank">#549</a></li>
<li>[<strong>bug</strong>] ay'con: remove whitespace on start <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/557"target="_blank">#557</a></li>
<li>[<strong>feature</strong>] taxonomy: add support fer category default taxonomy <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/541"target="_blank">#541</a></li>
<li>[<strong>bug</strong>] attachments: work fer Cap'n Hugo < 0.112 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/546"target="_blank">#546</a></li>
<li>[<strong>bug</strong>] shorrrtcodes: intermediately use random ids instead o' .Ordinal <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/543"target="_blank">#543</a></li>
<li>[<strong>feature</strong>] tab: new shortcode t' display single tab <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/537"target="_blank">#537</a></li>
<li>[<strong>feature</strong>] notice: make boxes more prominent <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/535"target="_blank">#535</a></li>
<li>[<strong>bug</strong>] attachments: fix build error since Cap'n Hugo 0.112 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/540"target="_blank">#540</a></li>
<li>[<strong>bug</strong>] tags: show taxonomy toc fer standard installat'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/533"target="_blank">#533</a></li>
<li>[<strong>bug</strong>] tags: translate breadcrumb an' title fer taxonomy <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/532"target="_blank">#532</a></li>
<li>[<strong>feature</strong>] tags: improve search index fer tags <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/531"target="_blank">#531</a></li>
<li>[<strong>feature</strong>] tags: increase readability o' taxonomy planks <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/530"target="_blank">#530</a></li>
<li>[<strong>feature</strong>] nav: make breadcrumb separator configur'ble <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/516"target="_blank">#516</a></li>
<li>[<strong>bug</strong>] shortcode: make .context always a plank <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/527"target="_blank">#527</a></li>
<li>[<strong>feature</strong>] theme: better HTML titles an' breadcrumbs fer search an' tag planks <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/521"target="_blank">#521</a></li>
<li>[<strong>bug</strong>] menu: avoid hid'n o' expander on hover when active item has children <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/515"target="_blank">#515</a></li>
<li>[<strong>bug</strong>] expand: not properly exanded when used 'n bullet point list <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/508"target="_blank">#508</a></li>
<li>[<strong>bug</strong>] theme: disableExplicitIndexURLs param be not work'n as expected <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/505"target="_blank">#505</a></li>
<li>[<strong>bug</strong>] attachments: fix links if only one language be present <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/502"target="_blank">#502</a></li>
<li>[<strong>bug</strong>] menu: fix state fer alwaysopen=false + collapsibleMenu=false <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/498"target="_blank">#498</a></li>
<li>[<strong>feature</strong>] frontmatter: support VSCode Front Matter extension <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/471"target="_blank">#471</a></li>
<li>[<strong>feature</strong>] i18n: add full RTL support <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/470"target="_blank">#470</a></li>
<li>[<strong>feature</strong>] piratify: fix some quirks, arrr <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/466"target="_blank">#466</a></li>
<li>[<strong>bug</strong>] i18n: write code ltr even fer rtl languages <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/482"target="_blank">#482</a></li>
<li>[<strong>bug</strong>] nav: restore scroll posit'n on browser back <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/473"target="_blank">#473</a></li>
<li>[<strong>bug</strong>] tabs: nested tabs rrrambl'n be not displayed <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/468"target="_blank">#468</a></li>
<li>[<strong>bug</strong>] variant: include miss'n <code>theme-auto.css</code> 'n distribut'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/467"target="_blank">#467</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] variant: add support fer <code>prefers-color-scheme</code><ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/339"target="_blank">#339</a></li>
<li>[<strong>bug</strong>] swagger: avoid errors when us'n invalid rapi-doc fragment ids <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/463"target="_blank">#463</a></li>
<li>[<strong>bug</strong>] badge: fix text color fer IE11 <ahref="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 <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/450"target="_blank">#450</a></li>
<li>[<strong>task</strong>] build: check fer release notes before release <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/448"target="_blank">#448</a></li>
<li>[<strong>feature</strong>] shorrrtcodes: support fer accent color <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/422"target="_blank">#422</a></li>
<li>[<strong>bug</strong>] variant: fix search ay'con an' text color <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/437"target="_blank">#437</a></li>
<li>[<strong>bug</strong>][<strong>break'n</strong>] theme: allow planks on top level <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/434"target="_blank">#434</a></li>
<li>[<strong>task</strong>] build: switch t' wildcard version o' act'ns <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/428"target="_blank">#428</a></li>
<li>[<strong>bug</strong>] search: apply dependency scripts fer Hindi an' Japanese <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/427"target="_blank">#427</a></li>
<li>[<strong>feature</strong>] theme: make external link target configur'ble <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/426"target="_blank">#426</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: open external links 'n separate tab <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/417"target="_blank">#417</a></li>
<li>[<strong>bug</strong>] theme: fix alias fer home plank if defaultContentLanguageInSubdir=true <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/414"target="_blank">#414</a></li>
<li>[<strong>bug</strong>] theme: fix spac'n fer tag flyout 'n FF <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/413"target="_blank">#413</a></li>
<li>[<strong>bug</strong>] search: don’t freeze browser on long search terms <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/404"target="_blank">#404</a></li>
<li>[<strong>bug</strong>] variant: minor color adjustments <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/401"target="_blank">#401</a></li>
<li>[<strong>bug</strong>] menu: relax usage o' background color <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/399"target="_blank">#399</a></li>
<li>[<strong>bug</strong>] theme: make alias planks us'ble by file:// protocol <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/398"target="_blank">#398</a></li>
<li>[<strong>bug</strong>] theme: be compat'ble wit' Cap'n Hugo >= 0.95.0 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/397"target="_blank">#397</a></li>
<li>[<strong>feature</strong>] theme: make creat'n o' generator meta tag configur'ble <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/383"target="_blank">#383</a></li>
<li>[<strong>bug</strong>] theme: fix build errors when referenc'n SVGs 'n markdown <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/385"target="_blank">#385</a></li>
<li>[<strong>bug</strong>] theme: add id t' h1 elements <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/384"target="_blank">#384</a></li>
<li>[<strong>bug</strong>] rss: fix display o' hidden subpages <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/379"target="_blank">#379</a></li>
<li>[<strong>bug</strong>] tags: fix non-latin tag display on planks <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/378"target="_blank">#378</a></li>
<li>[<strong>bug</strong>] theme: fix typo 'n 404.html <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/375"target="_blank">#375</a></li>
<li>[<strong>bug</strong>] theme: fix multilang links when ship served from subdirectory <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/370"target="_blank">#370</a></li>
<li>[<strong>feature</strong>] mermaid: allow pass'n o' parameters wit' codefence rules <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/360"target="_blank">#360</a></li>
<li>[<strong>feature</strong>] i18n: support RTL <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/349"target="_blank">#349</a></li>
<li>[<strong>bug</strong>] children: remove unused <code>plank</code> parameter from docs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/336"target="_blank">#336</a></li>
<li>[<strong>bug</strong>] print: remove menu placeholder 'n Firefox <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/335"target="_blank">#335</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] menu: expand collapsed menus if search term be found 'n submenus <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/312"target="_blank">#312</a></li>
<li>[<strong>bug</strong>] print: switch mermaid an' swagger style before print <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/315"target="_blank">#315</a></li>
<li>[<strong>bug</strong>] mermaid: header be show'n up 'n FF <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/311"target="_blank">#311</a></li>
<li>[<strong>bug</strong>] tags: don’t count tags if plank be hidden <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/310"target="_blank">#310</a></li>
<li>[<strong>bug</strong>] ie11: no styles after rework o' archetypes <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/306"target="_blank">#306</a></li>
<li>[<strong>bug</strong>] theme: board CSS if JS be disabled <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/305"target="_blank">#305</a></li>
<li>[<strong>feature</strong>] history: don’t reload plank when history gets cleared <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/299"target="_blank">#299</a></li>
<li>[<strong>feature</strong>] menu: replace expander by fontawesome chevrons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/296"target="_blank">#296</a></li>
<li>[<strong>feature</strong>] button: allow fer empty href <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/287"target="_blank">#287</a></li>
<li>[<strong>feature</strong>] clipboard: move head styles t' stylesheet <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/286"target="_blank">#286</a></li>
<li>[<strong>bug</strong>] favicon: fix URL if ship resides 'n subfolder <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/297"target="_blank">#297</a></li>
<li>[<strong>bug</strong>] print: add miss'n plank break after index or section <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/289"target="_blank">#289</a></li>
<li>[<strong>bug</strong>] swagger: javascript code does not board 'n documentat'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/285"target="_blank">#285</a></li>
<li>[<strong>bug</strong>] children: descript'ns not work'n <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/283"target="_blank">#283</a></li>
<li>[<strong>bug</strong>] theme: fix url fer logo an' home button <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/282"target="_blank">#282</a></li>
<li>[<strong>bug</strong>][<strong>break'n</strong>] include: second parameter be ignored <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/281"target="_blank">#281</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] tabs: don’t change tab select'n if panel does not contain item <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/279"target="_blank">#279</a></li>
<li>[<strong>bug</strong>] search: fix console message fer miss'n lunr translat'ns <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/272"target="_blank">#272</a></li>
<li>[<strong>bug</strong>] i18n: Vietnamese language wit' wrong lang code <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/269"target="_blank">#269</a></li>
<li>[<strong>bug</strong>] swagger: adjust font-size fer method buttons <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/263"target="_blank">#263</a></li>
<li>[<strong>bug</strong>] theme: let browser scroll plank on CTRL+f <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/242"target="_blank">#242</a></li>
<li>[<strong>feature</strong>] shorrrtcodes: add named parameter if miss'n <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/256"target="_blank">#256</a></li>
<li>[<strong>feature</strong>] i18n: add Italian translat'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/254"target="_blank">#254</a></li>
<li>[<strong>feature</strong>] attachments: support fer brand colors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/252"target="_blank">#252</a></li>
<li>[<strong>feature</strong>] notice: support fer brand colors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/251"target="_blank">#251</a></li>
<li>[<strong>feature</strong>] theme: use proper file extension fer page-meta.go <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/239"target="_blank">#239</a></li>
<li>[<strong>bug</strong>] shorrrtcodes: accept boolean parameters if given as str'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/261"target="_blank">#261</a></li>
<li>[<strong>bug</strong>] print: show Merrrmaid if requested 'n frontmatter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/255"target="_blank">#255</a></li>
<li>[<strong>bug</strong>] theme: fix display o' tooltip fer head'n anchor <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/241"target="_blank">#241</a></li>
<li>[<strong>feature</strong>] i18n: add Traditional Chinese translat'n <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/231"target="_blank">#231</a></li>
<li>[<strong>feature</strong>] theme: add CSS font variables <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/226"target="_blank">#226</a></li>
<li>[<strong>bug</strong>] variant: make variant switch work on slow networks <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/228"target="_blank">#228</a></li>
<li>[<strong>bug</strong>] print: fix minor inconsistencies <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/223"target="_blank">#223</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] mermaid: support differ'n themes fer color variant switch <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/219"target="_blank">#219</a></li>
<li>[<strong>feature</strong>] mermaid: board javascript on demand <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/218"target="_blank">#218</a></li>
<li>[<strong>bug</strong>] theme: make storage o' multiple Cap'n Hugo sites on same server distinct <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/214"target="_blank">#214</a></li>
<li>[<strong>bug</strong>] variant: switch breadcrumb color 'n Chrome <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/213"target="_blank">#213</a></li>
<li>[<strong>bug</strong>] mobile: improve behavior o' sidebar menu <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/210"target="_blank">#210</a></li>
<li>[<strong>bug</strong>] variant: fix occasional fail when resett'n generator <ahref="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 <ahref="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 <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/202"target="_blank">#202</a></li>
<li>[<strong>feature</strong>] tags: show tag count 'n taxonomy list <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/195"target="_blank">#195</a></li>
<li>[<strong>bug</strong>] theme: remove Cap'n Hugo build warning if plank be not file based <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/197"target="_blank">#197</a></li>
<li>[<strong>feature</strong>] variant: build a variant generator <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/182"target="_blank">#182</a></li>
<li>[<strong>feature</strong>] theme: support fer dark mode <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/174"target="_blank">#174</a></li>
<li>[<strong>bug</strong>] search: remove additional X 'n filled out search box 'n IE11 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/190"target="_blank">#190</a></li>
<li>[<strong>bug</strong>][<strong>change</strong>] search: fix color change fer ay'cons on hover <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/176"target="_blank">#176</a></li>
<li>[<strong>bug</strong>] exampleSite: fix links 'n official documentat'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/168"target="_blank">#168</a></li>
<li>[<strong>bug</strong>] menu: invalid URL when th' shortcut be an internal link <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/163"target="_blank">#163</a></li>
<li>[<strong>feature</strong>] theme: add theme version info t' head <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/158"target="_blank">#158</a></li>
<li>[<strong>bug</strong>] theme: fix select'n o' *.ico files as favicons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/160"target="_blank">#160</a></li>
<li>[<strong>bug</strong>] menu: fix significantly low performance fer collect'n o' meta info <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/157"target="_blank">#157</a></li>
<li>[<strong>bug</strong>] search: make dropdown stick t' search field when scroll'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/155"target="_blank">#155</a></li>
<li>[<strong>bug</strong>] menu: align long text properly <ahref="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><ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/149"target="_blank">#149</a></li>
<li>[<strong>bug</strong>] mermaid: let zoom reset t' initial size <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/145"target="_blank">#145</a></li>
<li>[<strong>bug</strong>] mermaid: remove whitespace from big graphs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/143"target="_blank">#143</a></li>
<li>[<strong>bug</strong>] mermaid: always board javascript t' avoid break if code fences be used <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/142"target="_blank">#142</a></li>
<li>[<strong>bug</strong>] search: don’t break JS 'n multilang setup if search be disabled <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/140"target="_blank">#140</a></li>
<li>[<strong>feature</strong>] toc: make disableTOC globally avail'ble via config.toml <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/133"target="_blank">#133</a></li>
<li>[<strong>feature</strong>] mermaid: only board javascript if necessary <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/95"target="_blank">#95</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: switch font <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/83"target="_blank">#83</a></li>
<li>[<strong>feature</strong>] theme: make favicon configur'ble <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/2"target="_blank">#2</a></li>
<li>[<strong>bug</strong>] mermaid: assert that window.mermaid be actually mermaid <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/136"target="_blank">#136</a></li>
<li>[<strong>bug</strong>] menu: remove usage o' Hugos UniqueID <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/131"target="_blank">#131</a></li>
<li>[<strong>bug</strong>] theme: reduce margin fer children shortcode <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/130"target="_blank">#130</a></li>
<li>[<strong>bug</strong>] theme: generate correct links if theme served from subdirectory <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/120"target="_blank">#120</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] rules highlight: provide default colors fer unknown languages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/113"target="_blank">#113</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: simplify stylesheet fer color variants <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/107"target="_blank">#107</a></li>
<li>[<strong>feature</strong>] theme: announce alternative rrrambl'n 'n header <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/101"target="_blank">#101</a></li>
<li>[<strong>feature</strong>] menu: add default sett'n fer menu expansion <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/97"target="_blank">#97</a></li>
<li>[<strong>bug</strong>] include: don’t generate additional HTML if file should be displayed “as is”<ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/105"target="_blank">#105</a></li>
<li>[<strong>bug</strong>] theme: fix usage o' section element <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/88"target="_blank">#88</a></li>
<li>[<strong>bug</strong>] theme: fix showVisitedLinks 'n case Cap'n Hugo be configured t' modify relative URLs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/86"target="_blank">#86</a></li>
<li>[<strong>feature</strong>] search: open expand if it contains search term <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/80"target="_blank">#80</a></li>
<li>[<strong>feature</strong>] menu: scroll active item into view <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/76"target="_blank">#76</a></li>
<li>[<strong>feature</strong>] search: improve readablility o' index.json <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/75"target="_blank">#75</a></li>
<li>[<strong>feature</strong>] menu: show hidden planks if accessed directly <ahref="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 <ahref="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 <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/55"target="_blank">#55</a></li>
<li>[<strong>feature</strong>] children: add parameter fer container style <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/53"target="_blank">#53</a></li>
<li>[<strong>feature</strong>] theme: make rrrambl'n a template <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/43"target="_blank">#43</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] code highlighter: switch t' standard hugo highlighter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/32"target="_blank">#32</a></li>
<li>[<strong>bug</strong>] theme: remove superfluous singular taxonomy from taxonomy title <ahref="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 <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/44"target="_blank">#44</a></li>
<li>[<strong>task</strong>] docs: include changelog 'n exampleSite <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/33"target="_blank">#33</a></li>
<li>[<strong>feature</strong>] expand: add opt'n t' open on plank board <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/25"target="_blank">#25</a></li>
<li>[<strong>feature</strong>] notice: make restyl'n o' notice boxes more robust <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/20"target="_blank">#20</a></li>
<li>[<strong>feature</strong>] notice: align box colors t' common standards <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/17"target="_blank">#17</a></li>
<li>[<strong>bug</strong>] attachments: support i18n fer attachment size <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/21"target="_blank">#21</a></li>
<li>[<strong>bug</strong>] notice: support i18n fer box labels <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/15"target="_blank">#15</a></li>
<li>[<strong>task</strong>] theme: prepare fer new hugo theme registrat'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/13"target="_blank">#13</a></li>
<li>[<strong>bug</strong>] mermaid: config opt'n fer CDN url not used <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/10"target="_blank">#10</a></li>
<li>[<strong>bug</strong>] mermaid: support pan & zoom fer graphs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/9"target="_blank">#9</a></li>
<li>[<strong>bug</strong>] mermaid: code fences not always rendered <ahref="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 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/5"target="_blank">#5</a></li>
<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>
<p>Org'nize yer ship like <ahref="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>
<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 <ahref="https://gohugo.io/overview/quickstart/"target="_blank">great documentat'n fer beginners</a>.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new ship <new_project></span></span></code></pre></div><p>Th' Relearrrn theme provides <ahref="../cont/archetypes/">archetypes</a> t' help ye create this kind o' planks.</p>
<p>Each Cap'n Hugo plank has t' define a <ahref="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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># T'ble o' contents (toc) be enabled by default. Set this parameter t' true t' dis'ble it.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Avast: Toc be always disabled fer chapter planks</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will be used fer th' page's menu entry (instead o' th' `title` attribute)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="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><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will explicitly override common rules fer th' expand state o' a page's menu entry</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will explicitly override common rules fer th' sort'n order o' a page's submenu entries</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Display name o' this plank modifier. If set, it will be displayed 'n th' footer.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Email o' this plank modifier. If set wit' LastModifierDisplayName, it will be displayed 'n th' footer</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Override default values fer image effects, ye can even add yer own arbitrary effects t' th' list</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="err">+++</span></span></span></code></pre></div><h3id="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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="err">+++</span></span></span></code></pre></div><h3id="using-a-custom-title-for-menu-entries">Us'n a custom title fer menu entries</h3>
</span></span><spanclass="line"><spanclass="cl"><spanclass="err">+++</span></span></span></code></pre></div><h3id="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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="nx">collapsibleMenu</span><spanclass="p">=</span><spanclass="kc">true</span><spanclass="c"># this adds th' expander t' th' menu entry if not already set 'n yer config.toml</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">render</span><spanclass="p">=</span><spanclass="s2">"never"</span><spanclass="c"># no plank will be generated so th' plank does not have a url</span></span></span></code></pre></div>
<p>Us'n th' command: <code>hugo new [relative new rrrambl'n path]</code>, ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: <ahref="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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="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>
<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>
</span></span><spanclass="line"><spanclass="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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new <chapter>/<name>/_index.md</span></span></code></pre></div><p>or</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new <chapter>/<name>.md</span></span></code></pre></div><p>This leads t' a file wit' th' follow'n rrrambl'n</p>
</span></span><spanclass="line"><spanclass="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>
<p>If ye be 'n need o' further archetypes ye can define yer own or even redefine exist'n ones.</p>
<h3id="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>
</span></span><spanclass="line"><spanclass="cl">+++</span></span></code></pre></div><p>Afterwards ye can generate new rrrambl'n files o' that kind wit' th' follow'n command</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind <kind><name>/_index.md</span></span></code></pre></div><h3id="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>
<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>
<p>Each hook file can be overridden o' a specific <ahref="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>
<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>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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
</span></span><spanclass="line"><spanclass="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>
<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>
<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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
</span></span><spanclass="line"><spanclass="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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">~~Strike through this text~~</span></span></code></pre></div>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">Do'ble quotes <spanclass="sb">`"`</span> an' single quotes <spanclass="sb">`'`</span> o' enclosed text be replaced by <spanclass="ge">**</span>"do'ble curly quotes"** an' <spanclass="ge">**</span>'single curly quotes'**.
</span></span><spanclass="line"><spanclass="cl">Do'ble dashes <spanclass="sb">`--`</span> an' triple dashes <spanclass="sb">`---`</span> be replaced by en-dash <spanclass="ge">**</span>--** an' em-dash <spanclass="ge">**</span>---** entities.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">Do'ble arrows point'n left <spanclass="sb">`<<`</span> or right <spanclass="sb">`>>`</span> be replaced by arrow <spanclass="ge">**</span><spanclass="err"><<</span>** an' <spanclass="ge">**</span>>>** entities.
</span></span><spanclass="line"><spanclass="cl">Three consecutive dots <spanclass="sb">`...`</span> be replaced by an ellipsis <spanclass="ge">**</span>...** entity.</span></span></code></pre></div>
<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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">-</span> Lorem ipsum dolor sit amet
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Lorem ipsum dolor sit amet
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">- [x]</span> Basic Test
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">In this example, <spanclass="sb">`<div></div>`</span> be marked as code.</span></span></code></pre></div>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">Be impressed by my advanced code:
<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>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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="k"></span><spanclass="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><spanclass="line"><spanclass="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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">This be a link t' https://example.com.</span></span></code></pre></div>
<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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">That's some text wit' a footnote[^1]
<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>
</span></span><spanclass="line"><spanclass="cl">[laforge]: https://octodex.github.com/images/trekkie.jpg "Geordi La Forge"</span></span></code></pre></div>
<p>This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. Th' default <ahref="../cont/imageeffects/">behavior be configur'ble</a> thru yer <code>config.toml</code> or frontmatter parameter.</p>
<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>
<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>
<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>
<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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">weight</span><spanclass="p">=</span><spanclass="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>.
<h2id="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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s2">"Cap'n Hugo Relearrrn Theme"</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">weight</span><spanclass="p">=</span><spanclass="mi">40</span></span></span></code></pre></div><p>Read more about <ahref="https://gohugo.io/extras/menus/"target="_blank">hugo menu</a> an' <ahref="https://gohugo.io/content-management/multilingual/#menus"target="_blank">hugo multilingual menus</a></p>
<p>Make th' plank file fer th' shortcut a <ahref="https://gohugo.io/content-management/age-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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="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><spanclass="line"><spanclass="cl"><spanclass="nx">publishResources</span><spanclass="p">=</span><spanclass="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>
<p>Aft learn'n <ahref="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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="c"># English be th' default language</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s2">"Cap'n Hugo Relearrrn Theme"</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">languageName</span><spanclass="p">=</span><spanclass="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>
<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>
<p>Although th' theme supports a wide variety o' supported languages, th' site’s search via th' <ahref="https://lunrjs.com"target="_blank">Lunr</a> search library does not.
<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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">additionalContentLanguage</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"en"</span><spanclass="p">]</span></span></span></code></pre></div><p>As this be an array, ye can add multiple additional languages.</p>
<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>
<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>
<h2id="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>
<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>
<p>If ye define <ahref="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>
<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' <ahref="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>
<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 <ahref="https://gohugo.io/extras/shortcodes/"target="_blank">shorrrtcodes</a>. A shortcode be a simple snippet inside a plank.</p>
<p>Since Cap'n Hugo <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="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>
<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>
<td>Th' <ahref="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>
<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>
<td><ahref="../shortcodes/icon/#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>
<td>A <ahref="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>
<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>
<p>If yer plank be a branch bundle, attachments must be placed 'n a nested <code>_index.files</code> folder, accordingly.</p>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Arrr</span></span> This be only avail'ble fer Cap'n Hugo <<code>0.112.0</code></p>
<p>For simple planks, attachments must be placed 'n a folder named like yer plank an' end'n wit' <code>.files</code>.</p>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Arrr</span></span> This be only avail'ble fer Cap'n Hugo <<code>0.112.0</code></p>
<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>For further examples fer <strong>style</strong>, <strong>color</strong>, <strong>title</strong> an' <strong>ay'con</strong>, see th' <ahref="../shortcodes/notice/"><code>notice</code> shortcode</a> documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.</p>
<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>
<td>Th' <ahref="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>
<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>
<td><ahref="../shortcodes/icon/#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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="nx">Lorem</span><spanclass="nx">ipsum</span><spanclass="nx">dolor</span><spanclass="nx">sit</span><spanclass="nx">amet</span><spanclass="p">,</span><spanclass="nx">graecis</span><spanclass="nx">denique</span><spanclass="nx">ei</span><spanclass="nx">vel</span><spanclass="p">,</span><spanclass="nx">at</span><spanclass="nx">duo</span><spanclass="nx">primis</span><spanclass="nx">mandamus</span><spanclass="p">.</span><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">badge</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"blue"</span><spanclass="nx">ay'con</span><spanclass="p">=</span><spanclass="s">"rocket"</span><spanclass="o">%</span><spanclass="p">}}</span><spanclass="nx">Awesome</span><spanclass="p">{{</span><spanclass="o">%</span><spanclass="o">/</span><spanclass="nx">badge</span><spanclass="o">%</span><spanclass="p">}}</span><spanclass="nx">Et</span><spanclass="nx">legere</span><spanclass="nx">ocurreret</span><spanclass="nx">pri</span><spanclass="p">,</span><spanclass="nx">animal</span><spanclass="nx">tacimates</span><spanclass="nx">complectitur</span><spanclass="nx">ad</span><spanclass="nx">cum</span><spanclass="p">.</span><spanclass="nx">Cu</span><spanclass="nx">eum</span><spanclass="nx">inermis</span><spanclass="nx">inimicus</span><spanclass="nx">efficiendi</span><spanclass="p">.</span><spanclass="nx">Labore</span><spanclass="nx">officiis</span><spanclass="nx">his</span><spanclass="nx">ex</span><spanclass="p">,</span><spanclass="nx">soluta</span><spanclass="nx">officiis</span><spanclass="nx">concludaturque</span><spanclass="nx">ei</span><spanclass="nx">qui</span><spanclass="p">,</span><spanclass="nx">vide</span><spanclass="nx">sensibus</span><spanclass="nx">vim</span><spanclass="nx">ad</span><spanclass="p">.</span></span></span></code></pre></div><p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. <spanclass="badge cstyle blue badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-rocket"></i></span><spanclass="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>
<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>
<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>
<td>Th' <ahref="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>
<td><ahref="../shortcodes/icon/#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>
<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>
<td>Th' <ahref="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>
<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>
<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 - <ahref="https://gohugo.io/content/summaries/"target="_blank">read more info about summaries on gohugo.io</a>.</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>
<p>This be a demo child plank wit' a hidden child. Ye can still access th' hidden child <ahref="../shortcodes/children/children-1/children-1-1/children-1-1-1/">directly</a> or via th' search.</p>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">expand</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"Show me almost **endless** possibilities"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code</span></span></code></pre></div><blockquote>
<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>
<p>This shortcode be fully compat'ble wit' Hugo’s <ahref="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 <ahref="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>
<td>Th' language o' th' code t' highlight. Choose from one o' th' <ahref="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages"target="_blank">supported languages</a>. Case-insensitive.</td>
<td><strong>Extension</strong>. Arbitrary title fer code. This displays th' code like a <ahref="../shortcodes/tab/">single tab</a> if <code>hl_inline=false</code> (which be Hugos default).</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. <ahref="#configuration">See below</a>.</td>
<td>An optional, comma-separated list o' zero or more <ahref="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>
<p>Default values fer <ahref="https://gohugo.io/functions/highlight/#options"target="_blank">Hugo’s supported opt'ns</a> can be set via <ahref="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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># if `guessSyntax = true`, there will be no unstyled code even if no language</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># mandatory sett'n fer yer ship if ye want t' use Merrrmaid or Math codefences</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># th' shipped variants come wit' their own modified chroma rules highlightn'n</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># style which be imported 'n theme-relearn-light.css, theme-relearn-dark.css, etc.;</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># if ye want t' use a predefined style instead:</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - remove `noClasses` or set `noClasses = true`</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - set `style` t' a predefined style name</span>
<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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p">{{<</span><spanclass="o">/</span><spanclass="nx">highlight</span><spanclass="p">>}}</span></span></span></code></pre></div><divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-py"data-lang="py"><spanclass="line"><spanclass="ln">666</span><spanclass="cl"><spanclass="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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-py"data-lang="py"><spanclass="line"><spanclass="cl"><spanclass="c1"># a bit shorter</span>
<p>Browse through th' avail'ble ay'cons 'n th' <ahref="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' <ahref="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>
<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>
<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>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">include</span><spanclass="s">"shortcodes/INCLUDE_ME.md"</span><spanclass="o">%</span><spanclass="p">}}</span></span></span></code></pre></div><p>Ye can add standard markdown rules:</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="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>
<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” <ahref="#fnref:1"class="footnote-backref"role="doc-backlink">↩︎</a></p>
<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>
<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>T' use codefence rules ye have t' turn off <code>guessSyntax</code> fer th' <code>marrrkup.highlight</code> sett'n (<ahref="#configuration">see th' configurat'n section</a>).</p>
<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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># mandatory sett'n fer yer ship if ye want t' use Math codefences</span>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">Inline math be generated if ye use a single <spanclass="sb">`$`</span> as a delimiter around yer formulae: {{<spanclass="p"><</span><spanclass="nt">math</span><spanclass="p">></span>}}$\sqrt{3}${{<spanclass="p"><</span><spanclass="p">/</span><spanclass="nt">math</span><spanclass="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:
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">If ye delimit yer formulae by two consecutive <spanclass="sb">`$$`</span> it generates a new block.
</span></span><spanclass="line"><spanclass="cl">{{<spanclass="p"><</span><spanclass="p">/</span><spanclass="nt">math</span><spanclass="p">></span>}}</span></span></code></pre></div><p>If ye delimit yer formulae by two consecutive <code>$$</code> it generates a new block.</p>
<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>
<p>Th' <code>mermaid</code> shortcode generates diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown us'n th' <ahref="https://mermaidjs.github.io/"target="_blank">Merrrmaid</a> library.</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 Merrrmaid codefences (eg. GitHub) an' so yer markdown becomes more port'ble.</p>
<p>T' use codefence rules ye have t' turn off <code>guessSyntax</code> fer th' <code>marrrkup.highlight</code> sett'n (<ahref="#configuration">see th' configurat'n section</a>).</p>
<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' <ahref="#global-configuration-file">ship</a> or th' <ahref="#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>
<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 <ahref="https://mermaid-js.github.io/mermaid/#/directives?id=directives"target="_blank">diagram directives</a>.</p>
<p>See <ahref="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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># mandatory sett'n fer yer ship if ye want t' use Merrrmaid codefences</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">Person</span><spanclass="p">(</span><spanclass="nx">customerA</span><spanclass="p">,</span><spanclass="s">"Bank'n Customer A"</span><spanclass="p">,</span><spanclass="s">"A customer o' th' bank, wit' personal bank accounts."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">Person</span><spanclass="p">(</span><spanclass="nx">customerD</span><spanclass="p">,</span><spanclass="s">"Bank'n Customer D"</span><spanclass="p">,</span><spanclass="s">"A customer o' th' bank, <br/> wit' personal bank accounts."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">System</span><spanclass="p">(</span><spanclass="nx">SystemAA</span><spanclass="p">,</span><spanclass="s">"Internet Bank'n System"</span><spanclass="p">,</span><spanclass="s">"Allows customers t' view informat'n about their bank accounts, an' make payments."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">SystemDb_Ext</span><spanclass="p">(</span><spanclass="nx">SystemE</span><spanclass="p">,</span><spanclass="s">"Mainframe Bank'n System"</span><spanclass="p">,</span><spanclass="s">"Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">System</span><spanclass="p">(</span><spanclass="nx">SystemA</span><spanclass="p">,</span><spanclass="s">"Bank'n System A"</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">System</span><spanclass="p">(</span><spanclass="nx">SystemB</span><spanclass="p">,</span><spanclass="s">"Bank'n System B"</span><spanclass="p">,</span><spanclass="s">"A system o' th' bank, wit' personal bank accounts. next line."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">System_Ext</span><spanclass="p">(</span><spanclass="nx">SystemC</span><spanclass="p">,</span><spanclass="s">"E-mail system"</span><spanclass="p">,</span><spanclass="s">"The internal Microsoft Exchange e-mail system."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">SystemDb</span><spanclass="p">(</span><spanclass="nx">SystemD</span><spanclass="p">,</span><spanclass="s">"Bank'n System D Database"</span><spanclass="p">,</span><spanclass="s">"A system o' th' bank, wit' personal bank accounts."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">SystemQueue</span><spanclass="p">(</span><spanclass="nx">SystemF</span><spanclass="p">,</span><spanclass="s">"Bank'n System F Queue"</span><spanclass="p">,</span><spanclass="s">"A system o' th' bank."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">SystemQueue_Ext</span><spanclass="p">(</span><spanclass="nx">SystemG</span><spanclass="p">,</span><spanclass="s">"Bank'n System G Queue"</span><spanclass="p">,</span><spanclass="s">"A system o' th' bank, wit' personal bank accounts."</span><spanclass="p">)</span>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"primary"</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"There may be pirates"</span><spanclass="nx">ay'con</span><spanclass="p">=</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">primary</span><spanclass="s">"There may be pirates"</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<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>
<td>Th' <ahref="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>
<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>
<td><ahref="../shortcodes/icon/#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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code</span></span></code></pre></div><blockquote>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"warning"</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"Here be dragons"</span><spanclass="nx">ay'con</span><spanclass="p">=</span><spanclass="s">"dragon"</span><spanclass="o">%</span><spanclass="p">}}</span>
<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' <ahref="../basics/configuration/#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>
<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>
<td>Th' <ahref="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>
<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>
<td><ahref="../shortcodes/icon/#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>
<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>
<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>
<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>
<td>Sets a default value fer every contained tab. Can be overridden by each tab. See th' <ahref="../shortcodes/tab/#parameter"><code>tab</code> shortcode</a> fer poss'ble values.</td>
<td>Sets a default value fer every contained tab. Can be overridden by each tab. See th' <ahref="../shortcodes/tab/#parameter"><code>tab</code> shortcode</a> fer poss'ble values.</td>
<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' <ahref="../shortcodes/tab/#parameter"><code>tab</code> shortcode</a> fer poss'ble values.</p>
