<p>Fello' pirrates, be awarrre <b>some stuff may not work</b> fer us in this trrranslat'n. Like <b>table of rrramblings</b>, see'ng <b>Merrrmaids</b>, do'ng <b>math or chemistrrry</b> and stuff.</p></div>
<p>Fello' pirrates, be awarrre <b>some stuff may not work</b> fer us in this trrranslat'n. Like <b>table of rrramblings</b>, see'ng <b>Merrrmaids</b>, do'ng <b>math or chemistrrry</b> and stuff.</p></div>
<p>This document shows ye what’s new 'n th' latest release. For a detailed list o' changes, see th' <ahref="/hugo-theme-relearn/pir/basics/history/">history plank</a>.</p>
<p><strong>Break'n</strong>: A change that requires act'n by ye aft upgrad'n t' assure th' ship be still functional.</p>
<p><strong>Change</strong>: A change 'n default behavior. This may requires act'n by ye / may or may not be revert'ble by configurat'n.</p>
<p><strong>New</strong>: Marks new behavior ye might find interest'n or comes configur'ble.</p>
<p><strong>Change</strong>: <ahref="/hugo-theme-relearn/pir/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><strong>Change</strong>: Th' <ahref="/hugo-theme-relearn/pir/shortcodes/button/"><code>button</code> shorrrtcode</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><strong>New</strong>: Th' <ahref="/hugo-theme-relearn/pir/shortcodes/math/"><code>math</code> shorrrtcode</a> an' <ahref="/hugo-theme-relearn/pir/shortcodes/mermaid/"><code>mermaid</code> shorrrtcode</a> now also support th' <code>align</code> parameter if codefence rules be used.</p>
<p><strong>New</strong>: 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><strong>Change</strong>: In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Although th' functionality o' th' new implementat'n works wit' old browsers (Internet Explorer 11), th' display o' th' expander ay'cons does not an' be limited t' modern browsers.</p>
<p><strong>New</strong>: <ahref="/hugo-theme-relearn/pir/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><strong>New</strong>: Print'n fer th' <ahref="/hugo-theme-relearn/pir/shortcodes/swagger/"><code>swagger</code> shorrrtcode</a> was optimized t' expand sections that be usually closed 'n interactive mode. This requires <ahref="/hugo-theme-relearn/pir/basics/configuration/#activate-print-support">print support</a> t' be configured.</p>
<li><strong>Change</strong>: 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><strong>Change</strong>: Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a <code>index.print.html</code> t' th' default URL.</p>
<p>Ye can revert this behavior by overwrit'n th' PRINT output format sett'n 'n yer <code>config.toml</code>t':</p>
<p><strong>Break'n</strong>: 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><strong>Change</strong>: Th' way <ahref="/hugo-theme-relearn/pir/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 aft th' upgrade. Nevertheless, it be recommended t' adapt yer exist'n markdown files t' th' new way as follows:</p>
<p><strong>Change</strong>: 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 aft th' upgrade.</p>
<p><strong>New</strong>: Th' new shorrrtcode <code>math</code> be avail'ble t' add beautiful math an' chemical formulae. See th' <ahref="/hugo-theme-relearn/pir/shortcodes/math/">documentat'n</a> fer avail'ble features. This feature will not work wit' Internet Explorer 11.</p>
<p><strong>Break'n</strong>: Th' second parameter fer th' <ahref="/hugo-theme-relearn/pir/shortcodes/include/"><code>include</code> shorrrtcode</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 shorrrtcode, th' default behavior hasn’t changed an' ye don’t need t' change anyth'n.</p>
<p><strong>Change</strong>: Previously, if th' <ahref="/hugo-theme-relearn/pir/shortcodes/tabs/"><code>tabs</code> shorrrtcode</a> could not find a tab item because, th' tabs ended up empty. Now th' first tab be selected instead.</p>
<p><strong>Change</strong>: 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.</p>
<p><strong>New</strong>: All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shorrrtcode.</p>
<li><strong>New</strong>: While fix'n issues wit' th' search functionality fer non Latin languages, ye can now <ahref="/hugo-theme-relearn/pir/cont/i18n/#search-with-mixed-language-support">configure t' have multiple languages on a single plank</a>.</li>
<p><strong>Break'n</strong>: 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><strong>Break'n</strong>: 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><strong>New</strong>: 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><strong>New</strong>: Th' <ahref="/hugo-theme-relearn/pir/shortcodes/button/"><code>button</code></a> shorrrtcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.</p>
</li>
<li>
<p><strong>New</strong>: 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><strong>Break'n</strong>: If ye had previously overwritten th' <code>custom-footer.html</code> partial t' add visual elements below th' rrrambl'n o' yer plank, ye have t' move this rrrambl'n t' th' new partial <code>content-footer.html</code>. <code>custom-footer.html</code> was never meant t' contain HTML other than additional styles an' JavaScript.</p>
<p><strong>New</strong>: If ye prefer expandable/collaps'ble menu items, ye can now set <code>collapsibleMenu=true</code> 'n yer <code>config.toml</code>. This will add arrows t' all menu items that contain sub menus. Th' menu will expand/collapse without navigat'n if ye click on an arrow.</p>
<p><strong>New</strong>: Ye can activate <ahref="/hugo-theme-relearn/pir/basics/configuration/#activate-print-support">print support</a> 'n yer <code>config.toml</code> t' add th' capability t' print whole chapters or even th' complete ship.</p>
<p><strong>New</strong>: 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="/hugo-theme-relearn/pir/basics/generator/">theme variant generator</a> o' th' exampleSite fer all avail'ble variables.</p>
<p><strong>New</strong>: Th' new shorrrtcode <code>swagger</code> be avail'ble t' include a UI fer REST OpenAPI Specificat'ns. See th' <ahref="/hugo-theme-relearn/pir/shortcodes/swagger/">documentat'n</a> fer avail'ble features. This feature will not work wit' Internet Explorer 11.</p>
</li>
</ul>
<hr>
<h2id="320">3.2.0</h2>
<ul>
<li>
<p><strong>Change</strong>: In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shorrrtcode or be us'n Merrrmaid codefences. This changes th' behavior o' <code>disableMermaid</code> config opt'n as follows: If a Merrrmaid shorrrtcode or codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.</p>
<p>Th' opt'n be still useful 'n case ye be us'n script'n t' set up yer graph. In this case no shorrrtcode or codefence be involved an' th' library be not boarded by default. In this case ye can set <code>disableMermaid=false</code> 'n yer frontmatter t' force th' library t' be boarded. See th' <ahref="/hugo-theme-relearn/pir/basics/generator/">theme variant generator</a> o' th' exampleSite fer an example.</p>
<p><strong>This change requires at least Cap'n Hugo 0.93.0 t' be used</strong>. Th' minimum requirement will be reported dur'n build on th' console if not met.</p>
</li>
<li>
<p><strong>New</strong>: Additional color variant vari'ble <code>--MERMAID-theme</code> t' set th' variant’s Merrrmaid theme. This causes th' Merrrmaid theme t' switch wit' th' color variant if it defers from th' sett'n o' th' formerly selected color variant.</p>
</li>
</ul>
<hr>
<h2id="310">3.1.0</h2>
<ul>
<li><strong>New</strong>: <ahref="/hugo-theme-relearn/pir/shortcodes/attachments/"><code>attachment</code></a> an' <ahref="/hugo-theme-relearn/pir/shortcodes/notice/"><code>notice</code></a> shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all <ahref="https://fontawesome.com/v5/search?m=free">Font Awesome 5 Free</a> ay'cons.</li>
</ul>
<hr>
<h2id="300">3.0.0</h2>
<ul>
<li>
<p><strong>Break'n</strong>: We made changes t' th' menu footer. If ye have yer <code>menu-footer.html</code><ahref="/hugo-theme-relearn/pir/basics/customization/">partial overridden</a>, ye may have t' review th' styl'n (eg. margins/paddings) 'n yer partial. For a reference take a look into th' <code>menu-footer.html</code> partial that be com'n wit' th' exampleSite.</p>
<p>This change was made t' allow yer own menu footer t' be placed right aft th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' <em>Clear history</em> functionality).</p>
</li>
<li>
<p><strong>Break'n</strong>: We have changed th' default colors from th' original Learrrn theme (the purple menu header) t' th' Relearrrn defaults (the light green menu header) as used 'n th' official documentat'n.</p>
<p>This change will only affect yer installat'n if you’ve not set th' <code>themeVariant</code> parameter 'n yer <code>config.toml</code>. <ahref="/hugo-theme-relearn/pir/basics/customization/#theme-variant">If ye still want t' use th' Learrrn color variant</a>, ye have t' explicitly set <code>themeVariant="learn"</code> 'n yer <code>config.toml</code>.</p>
<p>Avast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.</p>
<p><strong>Change</strong>: 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><strong>Change</strong>: For consistency reasons, we renamed <code>--MENU-SEARCH-BOX-color</code> t' <code>--MENU-SEARCH-BORDER-color</code>. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.</p>
</li>
<li>
<p><strong>New</strong>: Wit' this release ye be now cap'ble t' define yer own <em>dark mode</em> variants.</p>
<p>T' make this poss'ble, we have introduced a lot more color variables ye can use 'n <ahref="/hugo-theme-relearn/pir/basics/customization/#theme-variant">yer color variants</a>. Yer old variants will still work an' don’t need t' be changed as appropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.</p>
<p>T' see what’s now poss'ble, see th' new variants <code>relearn-dark</code> an' <code>neon</code> that be com'n wit' this release.</p>
</li>
<li>
<p><strong>New</strong>: T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive <ahref="/hugo-theme-relearn/pir/basics/generator/">theme variant generator</a>. This feature will not work wit' Internet Explorer 11.</p>
</li>
<li>
<p><strong>New</strong>: Ye can now configure multiple color variants 'n yer <code>config.toml</code>. In this case, th' first variant be th' default chosen on first view an' a variant switch will be shown 'n th' menu footer. See th' <ahref="/hugo-theme-relearn/pir/basics/customization/#multiple-variants">documentat'n</a> fer configurat'n.</p>
<p>Avast, that th' new variant switch will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant switcher will not be displayed wit' Internet Explorer 11.</p>
<p><strong>Break'n</strong>: This release removes th' themes implementat'n o' <code>ref</code>/<code>relref</code> 'n favor fer Hugos standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard 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">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">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> aft an upgrade an' no errors be written t' th' console.</p>
<p>Ye may see errors on th' console aft th' update 'n th' form:</p>
<divclass="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>
<ol>
<li>
<p>Copy th' old implementat'n files <code>theme/hugo-theme-relearn/layouts/shortcode/ref.html</code> an' <code>theme/hugo-theme-relearn/layouts/shortcode/relref.html</code> t' yer own projects <code>layouts/shortcode/ref.html</code> an' <code>layouts/shortcode/relref.html</code> respectively. <strong>This be not recommended</strong> as yer project will still rely on non-standard behavior afterwards.</p>
</li>
<li>
<p>Start up a text editor wit' regular expression support fer search an' replace. Apply th' follow'n conversions 'n th' given order on all <code>*.md</code> files. <strong>This be th' recommended choice</strong>.</p>
<p><strong>Change</strong>: Although never officially documented, this release removes th' font <code>Novacento</code>/<code>Novecento</code>. If ye use it 'n an overwritten CSS please replace it wit' <code>Work Sans</code>. This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer Czech.</p>
<p><strong>New</strong>: Th' theme now supports favicons served from <code>static/images/</code> named as <code>favicon</code> or <code>logo</code> 'n SVG, PNG or ICO format <ahref="/hugo-theme-relearn/pir/basics/customization/#change-the-favicon">out o' th' box</a>. An overridden partial <code>layouts/partials/favicon.html</code> may not be necessary anymore 'n most cases.</p>
</li>
<li>
<p><strong>New</strong>: Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' <code>disableToc</code> opt'n 'n yer <code>config.toml</code>. For an example see <ahref="/hugo-theme-relearn/pir/basics/configuration/#global-site-parameters">th' example configurat'n</a>.</p>
</li>
</ul>
<hr>
<h2id="270">2.7.0</h2>
<ul>
<li><strong>New</strong>: Optional second parameter fer <ahref="/hugo-theme-relearn/pir/shortcodes/notice/"><code>notice</code></a> shorrrtcode t' set title 'n box header.</li>
</ul>
<hr>
<h2id="260">2.6.0</h2>
<ul>
<li><strong>New</strong>: Yer ship can now be served from a subfolder if ye set <code>baseURL</code> an' <code>canonifyURLs=true</code> 'n yer <code>config.toml</code>. See th' <ahref="/hugo-theme-relearn/pir/basics/configuration/#a-word-on-running-your-site-in-a-subfolder">documentat'n</a> fer a detailed example.</li>
<li><strong>Change</strong>: New colors <code>--CODE-BLOCK-color</code> an' <code>--CODE-BLOCK-BG-color</code> were added t' provide a fallback fer Hugos rules 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><strong>Change</strong>: Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included.</p>
</li>
<li>
<p><strong>New</strong>: Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n <code>disableTagHiddenPages=true</code> 'n yer <code>config.toml</code>.</p>
</li>
<li>
<p><strong>New</strong>: Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' <code>alwaysopen</code> opt'n 'n yer <code>config.toml</code>. Please see further <ahref="/hugo-theme-relearn/pir/cont/pages/#override-expand-state-rules-for-menu-entries">documentat'n</a> fer poss'ble values an' default behavior.</p>
</li>
<li>
<p><strong>New</strong>: New frontmatter <code>ordersectionsby</code> opt'n t' change immediate children sort'n 'n menu an' <code>children</code> shorrrtcode. Poss'ble values be <code>title</code> or <code>weight</code>.</p>
</li>
<li>
<p><strong>New</strong>: Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See <ahref="https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head">Cap'n Hugo documentat'n</a>.</p>
<li><strong>New</strong>: 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.</li>
<li><strong>New</strong>: Hidden planks be displayed by default 'n th' sitemap generated by Cap'n Hugo an' be therefore vis'ble fer search engine index'n. Ye can now turn off this behavior by sett'n <code>disableSeoHiddenPages=true</code> 'n yer <code>config.toml</code>.</li>
<p><strong>Change</strong>: 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><strong>New</strong>: Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n <code>disableSearchHiddenPages=true</code> 'n yer <code>config.toml</code>.</p>
</li>
<li>
<p><strong>New</strong>: If a search term be found 'n an <code>expand</code> shorrrtcode, th' expand will be opened.</p>
</li>
<li>
<p><strong>New</strong>: Th' menu will scroll th' active item into view on board.</p>
<p><strong>Change</strong>: Rules highlight'n was switched t' th' <ahref="https://gohugo.io/content-management/syntax-highlighting/">built 'n Hugo mechanism</a>. Ye may need t' configure a new stylesheet or decide t' roll ye own as described on 'n th' Cap'n Hugo documentat'n</p>
<p><strong>Change</strong>: In th' predefined stylesheets there was a typo an' <code>--MENU-HOME-LINK-HOVERED-color</code> must be changed t' <code>--MENU-HOME-LINK-HOVER-color</code>. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.</p>
</li>
<li>
<p><strong>Change</strong>: <code>--MENU-HOME-LINK-color</code> an' <code>--MENU-HOME-LINK-HOVER-color</code> were miss'n 'n th' documentat'n. Ye should add them t' yer custom stylesheets if ye want t' override th' defaults.</p>
</li>
<li>
<p><strong>Change</strong>: Arrow navigat'n an' <code>children</code> shorrrtcode were ignor'n sett'n fer <code>ordersectionsby</code>. This be now changed an' may result 'n different sort'n order o' yer sub planks.</p>
</li>
<li>
<p><strong>Change</strong>: If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.</p>
</li>
<li>
<p><strong>Change</strong>: A plank without a <code>title</code> will be treated as <code>hidden=true</code>.</p>
</li>
<li>
<p><strong>New</strong>: Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further <ahref="/hugo-theme-relearn/pir/cont/pages/#override-expand-state-rules-for-menu-entries">documentat'n</a> fer poss'ble values an' default behavior.</p>
</li>
<li>
<p><strong>New</strong>: New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See <ahref="/hugo-theme-relearn/pir/basics/customization/">documentat'n</a> fer further read'n.</p>
</li>
<li>
<p><strong>New</strong>: Shorrrtcode <ahref="/hugo-theme-relearn/pir/shortcodes/children/"><code>children</code></a> wit' new parameter <code>containerstyle</code>.</p>
</li>
<li>
<p><strong>New</strong>: New shorrrtcode <ahref="/hugo-theme-relearn/pir/shortcodes/include/"><code>include</code></a> t' include arbitrary file rrrambl'n into a plank.</p>
</li>
</ul>
<hr>
<h2id="120">1.2.0</h2>
<ul>
<li><strong>New</strong>: Shorrrtcode <ahref="/hugo-theme-relearn/pir/shortcodes/expand/"><code>expand</code></a> wit' new parameter t' open on plank board.</li>
</ul>
<hr>
<h2id="110">1.1.0</h2>
<ul>
<li><strong>New</strong>: <ahref="/hugo-theme-relearn/pir/shortcodes/mermaid/#configuration"><code>Merrrmaid</code></a> config opt'ns can be set 'n <code>config.toml</code>.</li>
<li><strong>New</strong>: Initial fork o' th' <ahref="https://github.com/matcornic/hugo-theme-learn">Learrrn theme</a> based on Learrrn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename t' <code>Relearrrn</code> an' a new logo. For th' reasons behind fork'n th' Learrrn theme, see <ahref="https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495">this comment</a> 'n th' Learrrn issues.</li>
<p>Fello' pirrates, be awarrre <b>some stuff may not work</b> fer us in this trrranslat'n. Like <b>table of rrramblings</b>, see'ng <b>Merrrmaids</b>, do'ng <b>math or chemistrrry</b> and stuff.</p></div>
<p>Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.</p>
<p>Just download latest version o' <ahref="https://gohugo.io/getting-started/installing/">Cap'n Hugo binary</a> fer yer OS (Windows, Linux, Mac) : it’s that simple.</p>
<p>Fello' pirrates, be awarrre <b>some stuff may not work</b> fer us in this trrranslat'n. Like <b>table of rrramblings</b>, see'ng <b>Merrrmaids</b>, do'ng <b>math or chemistrrry</b> and stuff.</p></div>
<p>Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this <ahref="https://gohugo.io/overview/quickstart/">great documentat'n fer beginners</a>.</p>
<h2id="create-your-project">Create yer project</h2>
<p>Cap'n Hugo provides a <code>new</code> command t' create a new website.</p>
<pretabindex="0"><code>hugo new ship <new_project>
<p>Alternatively, ye can <ahref="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip">download th' theme as .zip</a> file an' extract it 'n th' <code>themes</code> directory</p>
<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>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="c"># Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo</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>
<p>Th' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command</p>
<divclass="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="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>
</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/">Netlify</a> (Read more about <ahref="https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/">Automated HUGO deployments wit' Netlify</a>). Alternatively, ye can use <ahref="https://gohugo.io/hosting-and-deployment/hosting-on-github/">GitHub planks</a></p>
<p>Fello' pirrates, be awarrre <b>some stuff may not work</b> fer us in this trrranslat'n. Like <b>table of rrramblings</b>, see'ng <b>Merrrmaids</b>, do'ng <b>math or chemistrrry</b> and stuff.</p></div>
<p>On top o' <ahref="https://gohugo.io/overview/configuration/">Cap'n Hugo global configurat'n</a>, th' Relearrrn theme lets ye define th' follow'n parameters 'n yer <code>config.toml</code> (here, values be default).</p>
<p>Avast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n.</p>
</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"># 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 shorrrtcode 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 shorrrtcode or Merrrmaid codefence be present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set t' false, board th' Swagger module on every plank regardless if a Swagger shorrrtcode be present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Order sections 'n menu by "weight" or "title". Default t' "weight";</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"># Change default color scheme wit' a variant one. Eg. can be "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"># Must be set t' th' same value as th' global uglyURLs sett'n; this adds 'index.html' t' all home links if set t' true</span>
<p>Th' theme runs best if yer ship be installed 'n th' root o' yer webserver. If yer ship be served from a subfolder, eg. <code>https://example.com/mysite/</code>, ye have t' set th' follow'n lines t' yer <code>config.toml</code></p>
</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">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>
</span></span></code></pre></div><p>Because th' global <code>uglyURLs</code> sett'n be not query'ble 'n th' theme’s code, you’ll have t' set this opt'n also 'n th' <code>[params]</code> section o' yer <code>config.toml</code>.</p>
<p>If ye want t' use th' search feature wit' an exist'n installat'n 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></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.js javascript search engine.</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></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">configured ugly</a> 'n terms o' <ahref="https://gohugo.io/content-management/urls/#ugly-urls">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="/hugo-theme-relearn/pir/shortcodes/math/">Math</a> fer additional documentat'n.</p>
<h3id="math-example">Example</h3>
<p>MathJax be globally disabled. By default it won’t be boarded by any plank.</p>
<p>On plank “Physics” ye coded some JavaScript fer a dynamic formulae. Ye can set th' MathJax parameters locally t' board mathJax on this plank.</p>
<p>Ye also can dis'ble MathJax fer specific planks while globally enabled.</p>
<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="/hugo-theme-relearn/pir/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>
<p>Fello' pirrates, be awarrre <b>some stuff may not work</b> fer us in this trrranslat'n. Like <b>table of rrramblings</b>, see'ng <b>Merrrmaids</b>, do'ng <b>math or chemistrrry</b> and stuff.</p></div>
<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/">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/">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>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>
<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/">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>
<p>If ye be not happy wit' th' shipped variants ye can either copy one o' th' shipped files, edit them 'n a text editor an' configure th' <code>themeVariant</code> parameter 'n yer <code>config.toml</code> or just use th' <ahref="/hugo-theme-relearn/pir/basics/generator/">interactive variant generator</a>.</p>
<p>Certain parts o' th' theme can be changed fer support o' yer own <ahref="https://gohugo.io/templates/output-formats/">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>Fello' pirrates, be awarrre <b>some stuff may not work</b> fer us in this trrranslat'n. Like <b>table of rrramblings</b>, see'ng <b>Merrrmaids</b>, do'ng <b>math or chemistrrry</b> and stuff.</p></div>
<p>This interactive tool may help ye t' generate yer own color variant stylesheet.</p>
<p>T' get started, first select a color variant from th' variant switch that fits ye best as a start'n point.</p>
<p>Th' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.</p>
<p>Th' arrowed lines reflects how colors be inherited thru different parts o' th' theme if th' descendent isn’t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.</p>
<p>T' better understand this select th' <code>neon</code> variant an' modify th' 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 change planks an' even close th' browser without los'n yer changes.</p>
<p>Once ye be satisfied, ye can download th' new variants file an' install it 'n yer ship.</p>
<p>Fello' pirrates, be awarrre <b>some stuff may not work</b> fer us in this trrranslat'n. Like <b>table of rrramblings</b>, see'ng <b>Merrrmaids</b>, do'ng <b>math or chemistrrry</b> and stuff.</p></div>
<li>[<strong>feature</strong>] mermaid: allow pass'n o' parameters wit' codefence rules <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/360">#360</a></li>
<li>[<strong>feature</strong>] i18n: support RTL <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/357">#357</a></li>
<li>[<strong>feature</strong>] button: add opt'n fer target <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/351">#351</a></li>
<li>[<strong>feature</strong>] theme: allow t' be served by file:// protocol <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/349">#349</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">#312</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">#310</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">#299</a></li>
<li>[<strong>feature</strong>] menu: replace expander by fontawesome chevrons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/296">#296</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">#287</a></li>
<li>[<strong>bug</strong>] favicon: fix URL if ship resides 'n subfolder <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/302">#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">#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">#297</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">#285</a></li>
<li>[<strong>bug</strong>] children: descript'ns not work'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/284">#284</a></li>
<li>[<strong>bug</strong>] print: fix empty plank fer shortcut links <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/283">#283</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">#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">#279</a></li>
<li>[<strong>bug</strong>] i18n: Vietnamese language wit' wrong lang code <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/270">#270</a></li>
<li>[<strong>bug</strong>] swagger: adjust font-size fer method buttons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/267">#267</a></li>
<li>[<strong>bug</strong>] menu: hide expander when only hidden subpages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/264">#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">#263</a></li>
<li>[<strong>feature</strong>] shorrrtcodes: add named parameter if miss'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/260">#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">#256</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">#246</a></li>
<li>[<strong>feature</strong>] variant: add support fer brand color variables <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/239">#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">#261</a></li>
<li>[<strong>bug</strong>] print: show Merrrmaid if requested 'n frontmatter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/255">#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">#241</a></li>
<li>[<strong>feature</strong>] i18n: add Traditional Chinese translat'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/233">#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">#231</a></li>
<li>[<strong>feature</strong>] theme: add CSS font variables <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/227">#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">#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">#228</a></li>
<li>[<strong>bug</strong>] print: fix minor inconsistencies <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/225">#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">#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">#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">#219</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">#214</a></li>
<li>[<strong>bug</strong>] variant: switch breadcrumb color 'n Chrome <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/213">#213</a></li>
<li>[<strong>bug</strong>] mobile: improve behavior o' sidebar menu <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/210">#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">#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">#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">#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">#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">#202</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">#197</a></li>
<li>[<strong>feature</strong>] variant: build a variant generator <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/188">#188</a></li>
<li>[<strong>feature</strong>] nav: only show toc if th' plank has head'ns <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/182">#182</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">#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">#176</a></li>
<li>[<strong>bug</strong>] exampleSite: fix links 'n official documentat'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/168">#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">#163</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">#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">#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">#155</a></li>
<li>[<strong>bug</strong>] menu: align long text properly <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/154">#154</a></li>
<li>[<strong>bug</strong>] copyToClipBoard: add miss'n right border fer inline code if <code>disableInlineCopyToClipBoard=true</code><ahref="https://github.com/McShelby/hugo-theme-relearn/issues/153">#153</a></li>
<li>[<strong>bug</strong>] menu: show hidden sibl'n planks reliably <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/152">#152</a></li>
<li>[<strong>bug</strong>] menu: br'n active item 'n sight fer large menus <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/149">#149</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">#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">#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">#133</a></li>
<li>[<strong>feature</strong>] mermaid: only board javascript if necessary <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/95">#95</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: switch font <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/83">#83</a></li>
<li>[<strong>feature</strong>] theme: make favicon configur'ble <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/2">#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">#136</a></li>
<li>[<strong>bug</strong>] menu: remove usage o' Hugos UniqueID <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/131">#131</a></li>
<li>[<strong>bug</strong>] theme: reduce margin fer children shorrrtcode <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/130">#130</a></li>
<li>[<strong>bug</strong>] theme: left-align h3 'n chapters <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/129">#129</a></li>
<li>[<strong>bug</strong>] theme: align copy link t' clipboard <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/128">#128</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">#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">#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">#107</a></li>
<li>[<strong>feature</strong>] theme: announce alternative rrrambl'n 'n header <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/101">#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">#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">#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">#105</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">#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">#80</a></li>
<li>[<strong>feature</strong>] menu: scroll active item into view <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/79">#79</a></li>
<li>[<strong>feature</strong>] search: dis'ble search 'n hidden planks <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/76">#76</a></li>
<li>[<strong>feature</strong>] search: improve readablility o' index.json <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/75">#75</a></li>
<li>[<strong>feature</strong>] menu: show hidden planks if accessed directly <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/60">#60</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: treat planks without title as hidden <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/59">#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">#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">#56</a></li>
<li>[<strong>feature</strong>] theme: make chapter archetype more read'ble <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/55">#55</a></li>
<li>[<strong>feature</strong>] children: add parameter fer container style <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/53">#53</a></li>
<li>[<strong>feature</strong>] theme: make rrrambl'n a template <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/50">#50</a></li>
<li>[<strong>feature</strong>] menu: control menu expansion wit' alwaysopen parameter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/49">#49</a></li>
<li>[<strong>feature</strong>] include: new shorrrtcode t' include other files <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/43">#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">#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">#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">#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">#44</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">#20</a></li>
<li>[<strong>feature</strong>] notice: align box colors t' common standards <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/18">#18</a></li>
<li>[<strong>feature</strong>] notice: use distinct ay'cons fer notice box type <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/17">#17</a></li>
<li>[<strong>bug</strong>] attachments: support i18n fer attachment size <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/21">#21</a></li>
<li>[<strong>bug</strong>] notice: support i18n fer box labels <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/16">#16</a></li>
<li>[<strong>bug</strong>] notice: support multiple blocks 'n one box <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/15">#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">#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">#12</a></li>
<li>[<strong>bug</strong>] mermaid: only highlight text 'n HTML elements <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/10">#10</a></li>
<li>[<strong>bug</strong>] mermaid: support pan & zoom fer graphs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/9">#9</a></li>
<li>[<strong>bug</strong>] mermaid: code fences not always rendered <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/6">#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">#5</a></li>
<aclass="github-button"href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip"data-icon="octicon-cloud-download"aria-label="Download McShelby/hugo-theme-relearn on GitHub">Download</a>
<aclass="github-button"href="https://github.com/McShelby/hugo-theme-relearn"data-icon="octicon-star"data-show-count="true"aria-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
<aclass="github-button"href="https://github.com/McShelby/hugo-theme-relearn/fork"data-icon="octicon-repo-forked"data-show-count="true"aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
<p>Built with <ahref="https://github.com/McShelby/hugo-theme-relearn"title="love"><iclass="fas fa-heart"></i></a> by <ahref="https://gohugo.io/">Hugo</a></p>
