<linkhref="https://McShelby.github.io/hugo-theme-relearn/pir/basics/migration/index.html"rel="canonical"type="text/html"title="What's new :: Cap'n Hugo Relearrrn Theme">
<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="../../../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 aft 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. This may requires act'n by ye / may or may not be revert'ble by configurat'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> 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> Th' new <ahref="../../../shortcodes/badge/"><code>badge</code> shorrrtcode</a> be now avail'ble t' add highly configur'ble markers t' yer rrrambl'n as ye can see it on this plank.</p>
</li>
<li>
<p><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 some o' GFM (GitHub Flavored Markdown) rules an' Hudo Marrrkdown extensions, namely <ahref="../../../cont/markdown/#tasks">task lists</a>, <ahref="../../../cont/markdown/#defintions">defint'n lists</a> an' <ahref="../../../cont/markdown/#footnotes">footnotes</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> 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> shorrrtcode</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>Ye can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.</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/#further-image-formatting">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> 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><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> shorrrtcode</a> an' <ahref="../../../shortcodes/mermaid/"><code>mermaid</code> shorrrtcode</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 fer 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. 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><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/swagger/"><code>swagger</code> shorrrtcode</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 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 aft 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 aft 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 shorrrtcode <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> 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><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> shorrrtcode</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.</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 shorrrtcode.</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> shorrrtcode 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> 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 fer 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 shorrrtcode <code>swagger</code> be avail'ble t' include a UI fer REST OpenAPI Specificat'ns. See th' <ahref="../../../shortcodes/swagger/">documentat'n</a> fer avail'ble features. This feature will not work wit' Internet Explorer 11.</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 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="../../../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>
<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">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 aft 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">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><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> shorrrtcode 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> shorrrtcode. 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">Cap'n Hugo documentat'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> 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><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 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> shorrrtcode, 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/">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> 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>
<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 shorrrtcode <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> Shorrrtcode <ahref="../../../shortcodes/expand/"><code>expand</code></a> wit' new parameter t' open on plank board.</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><ahref="../../../shortcodes/mermaid/#configuration"><code>Merrrmaid</code></a> config opt'ns can be set 'n <code>config.toml</code>.</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> 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>
