<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>
<li><strong>New</strong>: Th' new shorrrtcode <code>math</code> be avail'ble t' add beatiful 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.</li>
<p><strong>Break'n</strong>: Th' second parameter fer th' <ahref="/hugo-theme-relearn/pir/shortcodes/tabs/"><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>If you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achive th' same behavior.</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 savely remove this aswell 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 complexitity 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> respectivley.</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 distinguishs between <code>--MAIN-font</code> fer all rrrambl'n text an' <code>--CODE-font</code> fer inline or block code. There be additional overrides fer all head'ns. See th' <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>
<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>
<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><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>
<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>
<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>
<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 apropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.</p>
<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>
<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 complient an' exchang'n this theme 'n yer project t' some other theme will be effortless.</p>
<p>In a standard complient form ye must not link t' th' <code>*.md</code> file but t' its logical name. You’ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:</p>
<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 complient an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started <code>hugo server</code> aft an upgrade an' no errors be written t' th' console.</p>
<p>Ye may see errors on th' console aft th' update 'n th' form:</p>
<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>
<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><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>
<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 highlightn'n 'n case <code>guessSyntax=true</code> be set. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style.</li>
<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>
<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>
<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>
<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>
<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 provd'n a documentat'n translat'n “fer us pirrrates”. There will be no other translat'ns besides th' original English one an' th' Pirates one due t' maintenance constraints.</li>
<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 addional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see <code>CHANGELOG.md</code> 'n th' exampleSite), they will now be ignored by th' search.</p>
<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>: Syntaxhighlightn'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>
<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>
<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>
<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>
<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>
<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><strong>New</strong>: Shorrrtcode <ahref="/hugo-theme-relearn/pir/shortcodes/expand/"><code>expand</code></a> wit' new parameter t' open on plank board.</li>
<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>
<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"><iclass="fas fa-heart"></i></a> by <ahref="https://gohugo.io/">Hugo</a></p>
