<liitemscopeitemtype="https://schema.org/ListItem"itemprop="itemListElement"><metaitemprop="position"content="1"/><aitemprop="item"href="/hugo-theme-relearn/pir/"aria-disabled="true"><spanitemprop="name">Cap'n Hugo Relearrrn Theme</span></a></li>
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</div>
<h1id="hugo-relearn-theme">Cap'n Hugo Relearrrn Theme</h1>
<p>Th' <ahref="http://github.com/McShelby/hugo-theme-relearn">Relearrrn theme</a> be a theme fer <ahref="https://gohugo.io/">Cap'n Hugo</a>, a static website generator written 'n Go. Whar' Cap'n Hugo be often used fer blogs, this theme be designed wit' documentat'n 'n mind.</p>
<p>Th' theme be a fork o' th' great <ahref="https://github.com/matcornic/hugo-theme-learn">Learrrn theme</a> wit' th' aim o' fix'n long outstand'n bugs an' adept'n t' latest Cap'n Hugo features. As far as poss'ble this theme tries t' be a drop-in replacement fer th' Learrrn theme.</p>
<p>T' get support, feel free t' open a new <ahref="https://github.com/McShelby/hugo-theme-relearn/discussions">discussion topic</a> or <ahref="https://github.com/McShelby/hugo-theme-relearn/issues">issue</a> 'n th' official repository on GitHub.</p>
<h2id="become-a-contributor">Become a contributor</h2>
<p>Feel free t' update this documentat'n by just click'n th' <strong>Edit</strong> link displayed on top right o' each plank. Yer changes will be deployed automatically once they were reviewed.</p>
<p>Ye be most welcome t' contribute bugfixes or even new features t' th' source code by mak'n pull requests t' th' <ahref="https://github.com/McShelby/hugo-theme-relearn">official repository</a> via GitHub. Please visit th' <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/contribut'n.md">contribut'n guidelines</a> first.</p>
<h2id="license">License</h2>
<p>This theme be licensed under th' <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE">MIT License</a>.</p>
<h2id="credits">Credits</h2>
<p>This theme would not be poss'ble without th' work o' many others. See th' <ahref="/hugo-theme-relearn/pir/more/credits/">credits</a> fer a detailed list.</p>
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</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 some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</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 some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</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>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>
</li>
<li>
<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 apropriate 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>
</li>
</ul>
<hr>
<h2id="290">2.9.0</h2>
<ul>
<li>
<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>
<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>
</li>
<li>
<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>
</ul>
<hr>
<h2id="250">2.5.0</h2>
<ul>
<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>
</ul>
<hr>
<h2id="240">2.4.0</h2>
<ul>
<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 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>
</ul>
<hr>
<h2id="210">2.1.0</h2>
<ul>
<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>
</li>
<li>
<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>
</li>
</ul>
<hr>
<h2id="200">2.0.0</h2>
<ul>
<li>
<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>
</li>
<li>
<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>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' 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.</span>
</span></span></code></pre></div><h2id="a-word-on-running-your-site-in-a-subfolder">A word on runn'n yer ship 'n a subfolder</h2>
<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="activate-search">Activate search</h2>
<p>If not already present, add th' follow lines 'n th' same <code>config.toml</code> file.</p>
</span></span></code></pre></div><p>Relearrrn theme uses th' last improvement avail'ble 'n hugo version 20+ t' generate a json index file ready t' be consumed by lunr.js javascript search engine.</p>
<blockquote>
<p>Cap'n Hugo generate lunrjs index.json at th' root o' public folder.
When ye build th' ship wit' <code>hugo server</code>, hugo generates it internally an' o' course it doesn’t show up 'n th' filesystem</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>While colors o' yer chosen color variant be reset t' th' theme’s light standard values fer print'n, this does not apply fer Merrrmaid diagrams an' Swagger/OpenAPI Specificat'n. Those will still use th' colors o' yer chosen color variant which may cause a non coherent look on paper.</p>
</div>
</div>
<h2id="mermaid">Merrrmaid</h2>
<p>Th' Merrrmaid configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See <ahref="/hugo-theme-relearn/pir/shortcodes/mermaid/">Merrrmaid</a> fer additional documentat'n.</p>
<blockquote>
<p>Example:</p>
<p>Merrrmaid be globally disabled. By default it won’t be boarded by any plank.
On plank “Architecture” ye need a class diagram. Ye can set th' Merrrmaid parameters locally t' only board mermaid on this plank (not on th' others).</p>
</blockquote>
<p>Ye also can dis'ble Merrrmaid fer specific planks while globally enabled.</p>
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</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>
<p>This theme defines th' follow'n partials :</p>
<ul>
<li><code>header.html</code>: th' header o' th' plank. <em>Not meant t' be overwritten</em></li>
<li><code>footer.html</code>: th' footer o' th' plank.<em>Not meant t' be overwritten</em></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 Javacript. Don’t forget t' include <code>javascript</code> HTML tag directive 'n yer file.</li>
<li><code>favicon.html</code>: th' favicon</li>
<li><code>logo.html</code>: th' logo, on top left hand corner</li>
<li><code>meta.html</code>: HTML meta tags, if ye want t' change default behavior</li>
<li><code>menu-pre.html</code>: side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsiblity t' take th' page’s <code>pre</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 responsiblity t' take th' page’s <code>post</code> sett'n into account.</li>
<li><code>menu-footer.html</code>: footer o' th' the left menu</li>
<li><code>toc.html</code>: t'ble o' contents</li>
<li><code>rrrambl'n.html</code>: th' rrrambl'n plank itself. This can be overridden if ye wan’t t' display page’s meta data above or below th' rrrambl'n.</li>
<li><code>content-footer</code>: footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye don’t like it.</li>
</ul>
<h2id="change-the-logo">Change th' logo</h2>
<p>Create a new file 'n <code>layouts/partials/</code> named <code>logo.html</code>. Then write any HTML ye want.
Ye could use an <code>img</code> HTML tag an' reference an image created under th' <em>static</em> folder, or ye could paste a SVG definit'n!</p>
<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> respectivly.</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>
</span></span></code></pre></div><p>In th' above exaple yer theme file has t' be named <code>theme-relearn-light.css</code></p>
<h3id="multiple-variants">Multiple variants</h3>
<p>Ye can also set multiple variants. In this case, th' first variant be th' default choosen on first view an' a variant switch will be shown 'n th' menu footer.</p>
<p>If ye want t' switch th' rules highlightn'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>
</div>
</div>
<h3id="roll-your-own">Roll yer own</h3>
<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>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</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' differnet 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>
<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>] i18n: add italian translat'n <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/254">#254</a></li>
<li>[<strong>feature</strong>] attachments: support fer brand colors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/252">#252</a></li>
<li>[<strong>feature</strong>] notice: support fer brand colors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/251">#251</a></li>
<li>[<strong>feature</strong>] theme: use proper file extension fer page-meta.go <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/246">#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>
</ul>
<h3id="maintenance-3">Maintenance</h3>
<ul>
<li>[<strong>task</strong>] theme: switch from data-vocabulary t' schema <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/84">#84</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 highligher: switch t' standard hugo highlighter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/32">#32</a></li>
<li>[<strong>bug</strong>] theme: remove superflous 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>
</ul>
<h3id="maintenance-4">Maintenance</h3>
<ul>
<li>[<strong>task</strong>] docs: include changelog 'n exampleSite <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/33">#33</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>
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</div>
<p>In <strong>Cap'n Hugo</strong>, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.</p>
<h2id="folders">Folders</h2>
<p>Org'nize yer ship like <ahref="https://gohugo.io/content/organization/">any other Cap'n Hugo project</a>. Typically, ye will have a <em>rrrambl'n</em> folder wit' all yer planks.</p>
<p><code>_index.md</code> be required 'n each folder, it’s yer “folder home page”</p>
</div>
</div>
<h2id="types">Types</h2>
<p>Th' Relearrrn theme defines two types o' planks. <em>Default</em> an' <em>Chapter</em>. Both can be used at any level o' th' documentat'n, th' only difference be'n layout display.</p>
<h3id="chapter-style">Chapter</h3>
<p>A <strong>Chapter</strong> displays a plank meant t' be used as introduct'n fer a set o' child planks. Commonly, it contains a simple title an' a catch line t' define rrrambl'n that can be found under it.</p>
<p>Ye can define any HTML as prefix fer th' menu. In th' example below, it’s just a number but that could be an <ahref="https://fortawesome.github.io/Font-Awesome/">ay'con</a>.</p>
</span></span><spanclass="line"><spanclass="cl">Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.
</span></span></code></pre></div><p>T' tell th' Relearrrn theme t' consider a plank as a chapter, set <code>chapter=true</code> 'n th' Front Matter o' th' plank.</p>
<h3id="default">Default</h3>
<p>A <strong>Default</strong> plank be any other rrrambl'n plank.</p>
</span></span></code></pre></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 t' train 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>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new ship <new_project>
</span></span></code></pre></div><p>Th' Relearrrn theme provides <ahref="/hugo-theme-relearn/pir/cont/archetypes/">archetypes</a> t' help ye create this kind o' planks.</p>
<p>Each Cap'n Hugo plank has t' define a <ahref="https://gohugo.io/content/front-matter/">Front Matter</a> 'n <em>toml</em>, <em>yaml</em> or <em>json</em>. This ship will use <em>toml</em> 'n all cases.</p>
<p>Th' Relearrrn theme uses th' follow'n parameters on top o' Cap'n Hugo ones :</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># T'ble o' contents (toc) be enabled by default. Set this parameter t' true t' dis'ble it.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Avast: Toc be always disabled fer chapter planks</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will be used fer th' page's menu entry (instead o' th' `title` attribute)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will explicitly override common rules fer th' expand state o' a page's menu entry</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will explicitly override common rules fer th' sort'n order o' a page's submenu entries</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Display name o' this plank modifier. If set, it will be displayed 'n th' footer.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Email o' this plank modifier. If set wit' LastModifierDisplayName, it will be displayed 'n th' footer</span>
</span></span></code></pre></div><h3id="override-expand-state-rules-for-menu-entries">Override expand state rules fer menu entries</h3>
<p>Ye can change how th' theme expands menu entries on th' side o' th' rrrambl'n wit' th' <code>alwaysopen</code> sett'n on a per plank basis. If <code>alwaysopen=false</code> fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.</p>
<p>Th' theme generates th' menu based on th' follow'n rules:</p>
<ul>
<li>all parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns</li>
<li>immediate children entries o' th' active plank be shown regardless o' any sett'ns</li>
<li>if not overridden, all other first level entries behave like they would have been given <code>alwaysopen=false</code></li>
<li>if not overridden, all other entries o' levels besides th' first behave like they would have been given <code>alwaysopen=true</code></li>
<li>all vis'ble entries show their immediate children entries if <code>alwaysopen=true</code>; this proceeds recursivley</li>
<li>all remain'n entries be not shown</li>
</ul>
<p>Ye can see this feature 'n act'n on th' example plank fer <ahref="/hugo-theme-relearn/pir/shortcodes/children/">children shorrrtcode</a> an' its children planks.</p>
<h2id="your-page">Yer Plank</h2>
<p>T' configure yer plank, ye basically have three choices:</p>
<ol>
<li>Create an <code>_index.md</code> document 'n <code>rrrambl'n</code> folder an' fill th' file wit' <em>Marrrkdown rrrambl'n</em></li>
<li>Create an <code>index.html</code> file 'n th' <code>static</code> folder an' fill th' file wit' <em>HTML rrrambl'n</em></li>
<li>Configure yer server t' automatically redirect home plank t' one yer documentat'n plank</li>
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</div>
<p>Us'n th' command: <code>hugo new [relative new rrrambl'n path]</code>, ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: <ahref="https://gohugo.io/content/archetypes/">archetypes</a>.</p>
<p>It be pre-configured skeleton planks wit' default front matter. Please refer t' th' documentat'n fer types o' plank t' understand th' differences.</p>
<h2id="archetypes-chapter">Chapter</h2>
<p>T' create a Chapter plank, run th' follow'n commands</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind chapter <name>/_index.md
</span></span></code></pre></div><p>It will create a plank wit' predefined Front-Matter:</p>
<p>T' create a default plank, run either one o' th' follow'n commands either</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new <chapter>/<name>/_index.md
</span></span></code></pre></div><p>or</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new <chapter>/<name>.md
</span></span></code></pre></div><p>It will create a plank wit' predefined Front-Matter:</p>
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</div>
<p>Let’s face it: Writ'n rrrambl'n fer th' Web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.</p>
<p><strong>Marrrkdown</strong> be a better way t' write <strong>HTML</strong>, without all th' complexities an' ugliness that usually accompanies it.</p>
<p>Some o' th' key benefits be:</p>
<ol>
<li>Marrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n.</li>
<li>Less chance o' errors when writ'n 'n Marrrkdown.</li>
<li>Produces valid XHTML output.</li>
<li>Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship.</li>
<li>Write 'n any text editor or Marrrkdown applicat'n ye like.</li>
<li>Marrrkdown be a joy t' use!</li>
</ol>
<p>John Gruber, th' author o' Marrrkdown, puts it like this:</p>
<blockquote>
<p>Th' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email.
<cite>John Gruber</cite></p>
</blockquote>
<p>Without further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:</p>
</span></span></code></pre></div><p>Comment below should <strong>NOT</strong> be seen:</p>
<!--
This be a comment
-->
<h2id="horizontal-rules">Horizontal Rules</h2>
<p>Th' HTML <code><hr></code> element be fer creat'n a “thematic break” between paragraph-level elements. In Marrrkdown, ye can create a <code><hr></code> wit' <code>---</code> - three consecutive dashes</p>
<p>renders t':</p>
<hr>
<h2id="paragraphs">Paragraphs</h2>
<p>Any text not start'n wit' a special sign be written as normal, plain text an' will be wrapped within <code><p></p></code> tags 'n th' rendered HTML.</p>
<p>So this body copy:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
</span></span></code></pre></div><p>renders t' this HTML:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">p</span><spanclass="p">></span>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.<spanclass="p"></</span><spanclass="nt">p</span><spanclass="p">></span>
<p>For emphasiz'n a snippet o' text wit' a heavier font-weight.</p>
<p>Th' follow'n snippet o' text be <strong>rendered as bold text</strong>.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">**rendered as bold text**
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">strong</span><spanclass="p">></span>rendered as bold text<spanclass="p"></</span><spanclass="nt">strong</span><spanclass="p">></span>
<p>For emphasiz'n a snippet o' text wit' italics.</p>
<p>Th' follow'n snippet o' text be <em>rendered as italicized text</em>.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">_rendered as italicized text_
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">em</span><spanclass="p">></span>rendered as italicized text<spanclass="p"></</span><spanclass="nt">em</span><spanclass="p">></span>
<p>In GFM (GitHub flavored Markdown) ye can do strikethroughs.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">~~Strike through this text.~~
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">del</span><spanclass="p">></span>Strike through this text.<spanclass="p"></</span><spanclass="nt">del</span><spanclass="p">></span>
<p>For quot'n blocks o' rrrambl'n from another source within yer document.</p>
<p>Add <code>></code> before any text ye want t' quote.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">**Fusion Drive** combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.
<p><strong>Fusion Drive</strong> combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">p</span><spanclass="p">><</span><spanclass="nt">strong</span><spanclass="p">></span>Fusion Drive<spanclass="p"></</span><spanclass="nt">strong</span><spanclass="p">></span> combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.<spanclass="p"></</span><spanclass="nt">p</span><spanclass="p">></span>
</span></span></code></pre></div><p>Blockquotes can also be nested:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="k"></span><spanclass="ge">>> Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="k"></span><spanclass="ge">> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
<p>Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.</p>
<blockquote>
<p>Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.</p>
</blockquote>
<p>Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</p>
</blockquote>
<h2id="lists">Lists</h2>
<h3id="unordered">Unordered</h3>
<p>A list o' items 'n which th' order o' th' items does not explicitly matter.</p>
<p>Ye may use any o' th' follow'n symbols t' denote bullets fer each list item:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">+ Lorem ipsum dolor sit amet
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Lorem ipsum dolor sit amet<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Integer molestie lorem at massa<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Facilisis 'n pretium nisl aliquet<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Purus sodales ultricies<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Faucibus porta lacus fringilla vel<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Aenean sit amet erat nunc<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
<p>A list o' items 'n which th' order o' items does explicitly matter.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Lorem ipsum dolor sit amet
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Lorem ipsum dolor sit amet<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Integer molestie lorem at massa<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Facilisis 'n pretium nisl aliquet<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Faucibus porta lacus fringilla vel<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">li</span><spanclass="p">></span>Aenean sit amet erat nunc<spanclass="p"></</span><spanclass="nt">li</span><spanclass="p">></span>
<p>If ye just use <code>1.</code> fer each number, Marrrkdown will automatically number each item. For example:</p>
</div>
</div>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Lorem ipsum dolor sit amet
<p>Wrap inline snippets o' code wit' <code>`</code>.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">In this example, <spanclass="sb">`<div></div>`</span> should be wrapped as <spanclass="gs">**code**</span>.
<p>In this example, <code><div></div></code> should be wrapped as <strong>code</strong>.</p>
<p>HTML:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">p</span><spanclass="p">></span>In this example, <spanclass="p"><</span><spanclass="nt">code</span><spanclass="p">></span><spanclass="ni">&lt;</span>div<spanclass="ni">&gt;&lt;</span>/div<spanclass="ni">&gt;</span><spanclass="p"></</span><spanclass="nt">code</span><spanclass="p">></span> should be wrapped as <spanclass="p"><</span><spanclass="nt">strong</span><spanclass="p">></span>code<spanclass="p"></</span><spanclass="nt">strong</span><spanclass="p">></span>.<spanclass="p"></</span><spanclass="nt">p</span><spanclass="p">></span>
<p>Or indent several lines o' code by at least two spaces, as 'n:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"> // Some comments
</span></span><spanclass="line"><spanclass="cl"> line 1 o' code
</span></span><spanclass="line"><spanclass="cl"> line 2 o' code
</span></span><spanclass="line"><spanclass="cl"> line 3 o' code
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">code</span><spanclass="p">></span>Sample text here...<spanclass="p"></</span><spanclass="nt">code</span><spanclass="p">></span>
<p>GFM, or “GitHub Flavored Markdown” also supports rules highlight'n. T' activate it, usually ye simply add th' file extension o' th' language ye want t' use directly aft th' first code “fence”, <code>```js</code>, an' rules highlight'n will automatically be applied 'n th' rendered HTML.</p>
<p>See <ahref="/hugo-theme-relearn/pir/cont/syntaxhighlight/">Code Highlight'n</a> fer additional documentat'n.</p>
<p>For example, t' apply rules highlight'n t' JavaScript code:</p>
<p>Tables be created by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">td</span><spanclass="p">></span>path t' data files t' supply th' data that will be passed into templates.<spanclass="p"></</span><spanclass="nt">td</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">td</span><spanclass="p">></span>engine t' be used fer process'n templates. Handlebars be th' default.<spanclass="p"></</span><spanclass="nt">td</span><spanclass="p">></span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">td</span><spanclass="p">></span>extension t' be used fer dest files.<spanclass="p"></</span><spanclass="nt">td</span><spanclass="p">></span>
<p>Named anchors en'ble ye t' jump t' th' specified anchor point on th' same plank. For example, each o' these chapters:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="gh"># T'ble o' Contents
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="gu"></span>Rrrambl'n fer chapter one.
</span></span></code></pre></div><p><strong>NOTE</strong> that specific placement o' th' anchor tag seems t' be arbitrary. They be placed inline here since it seems t' be unobtrusive, an' it works.</p>
<h2id="images">Images</h2>
<p>Images have a similar rules t' links but include a preced'n exclamat'n point.</p>
<p>Add a HTTP <code>classes</code> parameter t' th' link image t' add CSS classes. <code>shadow</code>an' <code>border</code> be avail'ble but ye could define other ones.</p>
<p>Add a HTTP <code>featherlight</code> parameter t' th' link image t' dis'ble lightbox. By default lightbox be enabled us'n th' featherlight.js plugin. Ye can dis'ble this by defin'n <code>featherlight</code> t' <code>false</code>.</p>
<p>Cap'n Hugo comes wit' a <ahref="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages">remark'ble list</a> o' supported languages.</p>
<p>Ye can choose a color theme from th' <ahref="https://xyproto.github.io/splash/docs/all.html">list o' supported themes</a> an' add it 'n yer <code>config.toml</code></p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># if set t' `guessSyntax = true`, there will be no unstyled code even if no language</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># was given BUT mermaid code fences will not work anymore! So this be a mandatory</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># sett'n fer yer ship</span>
</span></span></code></pre></div><p>By default, shortcuts be preceded by a title. This title can be disabled by sett'n <code>disableShortcutsTitle=true</code>.
However, if ye want t' keep th' title but change its value, it can be overriden by chang'n yer local i18n translat'n str'n configurat'n.</p>
<p>For example, 'n yer local <code>i18n/en.toml</code> file, add th' follow'n rrrambl'n</p>
</span></span></code></pre></div><p>Read more about <ahref="https://gohugo.io/extras/menus/">hugo menu</a> an' <ahref="https://gohugo.io/content-management/multilingual/#translation-of-strings">hugo i18n translat'n str'ns</a></p>
<h2id="i18n">Configurat'n fer Multilingual mode</h2>
<p>When us'n a multilingual website, ye can set different menus fer each language. In th' <code>config.toml</code> file, prefix yer menu configurat'n by <code>Languages.<language-id></code>.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s2">"Cap'n Hugo Relearrrn Theme"</span>
</span></span></code></pre></div><p>Read more about <ahref="https://gohugo.io/extras/menus/">hugo menu</a> an' <ahref="https://gohugo.io/content-management/multilingual/#menus">hugo multilingual menus</a></p>
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</div>
<p>Th' Relearrrn theme fer Cap'n Hugo loads th' <ahref="https://fontawesome.com"><strong>Font Awesome</strong></a> library, allow'n ye t' easily display any ay'con or logo avail'ble 'n th' Font Awesome free collect'n.</p>
<h2id="finding-an-icon">Find'n an ay'con</h2>
<p>Browse through th' avail'ble ay'cons 'n th' <ahref="https://fontawesome.com/v5/search?m=free">Font Awesome Gallery</a>. Notice that th' <strong>free</strong> filter be enabled, as only th' free ay'cons be avail'ble by default.</p>
<p>Once on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' <ahref="https://fontawesome.com/v5/icons/heart?s=solid">heart</a>, copy th' HTML reference an' paste into th' Marrrkdown rrrambl'n.</p>
</span></span></code></pre></div><h2id="including-in-markdown">Includ'n 'n markdown</h2>
<p>Paste th' <code><i></code> HTML into marrrkup an' Font Awesome will board th' relevant ay'con.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl">Built wit' <spanclass="p"><</span><spanclass="nt">i</span><spanclass="na">class</span><spanclass="o">=</span><spanclass="s">"fas fa-heart"</span><spanclass="p">></</span><spanclass="nt">i</span><spanclass="p">></span> by Relearrrn an' Cap'n Hugo
<p>Aft learn'n <ahref="https://gohugo.io/content-management/multilingual">how Cap'n Hugo handle multilingual websites</a>, define yer languages 'n yer <code>config.toml</code> file.</p>
<p>For example wit' current English an' Piratized English website.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="c"># English be th' default language</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s2">"Cap'n Hugo Relearrrn Theme"</span>
<p>Translat'ns str'ns be used fer common default values used 'n th' theme (<em>Edit</em> button, <em>Search placeholder</em> an' so on). Translat'ns be avail'ble 'n English an' Piratized English but ye may use another language or want t' override default values.</p>
<p>T' override these values, create a new file 'n yer local i18n folder <code>i18n/<idlanguage>.toml</code> an' inspire yourself from th' theme <code>themes/hugo-theme-relearn/i18n/en.toml</code></p>
<h2id="disable-language-switching">Dis'ble language switch'n</h2>
<p>Switch'n th' language 'n th' browser be a great feature, but fer some reasons ye may want t' dis'ble it.</p>
<p>Just set <code>disableLanguageSwitchingButton=true</code> 'n yer <code>config.toml</code></p>
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</div>
<h3id="chapter-3">Chapter 3</h3>
<h1id="shortcodes">Shorrrtcodes</h1>
<p>Cap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well. Ye could use pure HTML t' expand possibilities.</p>
<p>But this happens t' be a bad idea. Everyone uses Marrrkdown because it’s pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.</p>
<p>T' avoid this limitat'ns, Cap'n Hugo created <ahref="https://gohugo.io/extras/shortcodes/">shorrrtcodes</a>. A shorrrtcode be a simple snippet inside a plank.</p>
<p>Th' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.</p>
<tdstyle="text-align:left">Th' color scheme used t' highlight th' box rrrambl'n.<br/><br/>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><nd color: <code>primary</code>, <code>secondary</code><br/>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br/>- by special color: <code>default</code>,t`</td>
<tdstyle="text-align:left">Arbitray text fer th' box title. Depend'n on th' <strong>style</strong> there may be a default title. Any given value will overwault.<br/><br/>- fer severity styles: th' match'n title fer th' severity<br/>- fer all other colors: <code>Attachments</code><br/><br/>If ye wa ye have t' set this parameter t' <code>""</code> (a non empty str'n filled wit' spaces)</td>
<tdstyle="text-align:left"><ahref="/hugo-theme-relearn/pir/cont/icons/#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' title. Depend'n le** there may be a default ay'con. Any given value will overwrite th' default.<br/><br/>- fer severity styles: a nice match'n iseverity<br/>- fer all other colors: <code>paperclip</code><br/><br/>If ye want no ay'con, ye have t' set this parameter t' <code>""</code> (a non empty d wit' spaces)</td>
<tdstyle="text-align:left">A <ahref="https://en.wikipedia.org/wiki/Regular_expression">regular expressions</a>, used t' filter th' attachments by file name. For example:<br/><br/>- t' match a file suffix o' ‘jpg’, use <code>.*jpg</code> (not <code>*.jpg</code>)<br/>- t' match file names end'n 'n <code>jpg</code> or <code>png</code>, use <code>.*(jpg|png)</code></td>
<p>For further examples fer <strong>style</strong>, <strong>title</strong> an' <strong>ay'con</strong>, see th' <ahref="/hugo-theme-relearn/pir/shortcodes/notice/"><code>notice</code> shorrrtcode</a> documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.</p>
<tdstyle="text-align:left">Th' destinat'n URL fer th' button. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble.</td>
<tdstyle="text-align:left">Th' color scheme used t' paint th' button.<br/><br/>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br/>- by brand color: <code>primary</code>, <code>secondary</code><br/>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br/>- by special color: <code>default</code>, <code>transparent</code></td>
<tdstyle="text-align:left"><ahref="/hugo-theme-relearn/pir/cont/icons/#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' title. Depend'n on th' <strong>style</strong> there may be a default ay'con. Any given value will overwrite th' default.<br/><br/>- fer severity styles: a nice match'n ay'con fer th' severity<br/>- fer all other colors: <em><empty></em><br/><br/>If ye want no ay'con fer a severity style, ye have t' set this parameter t' <code>""</code> (a non empty str'n filled wit' spaces)</td>
<tdstyle="text-align:left">Arbitray text fer th' button title. Depend'n on th' <strong>style</strong> there may be a default title. Any given value will overwrite th' default.<br/><br/>- fer severity styles: th' match'n title fer th' severity<br/>- fer all other colors: <em><empty></em><br/><br/>If ye want no title fer a severity style, ye have t' set this parameter t' <code>""</code> (a non empty str'n filled wit' spaces)</td>
<tdstyle="text-align:left">When <code>true</code> shows a short text under each plank 'n th' list. When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken - <ahref="https://gohugo.io/content/summaries/">read more info about summaries on gohugo.io</a>.</td>
<tdstyle="text-align:left">Th' depth o' descendants t' display. For example, if th' value be <code>2</code>, th' shorrrtcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. <code>999</code>.</td>
<tdstyle="text-align:left">Th' sort order o' th' displayed list.<br/><br/>If not set it be sorted by th' <ahref="/hugo-theme-relearn/pir/basics/configuration/#global-site-parameters"><code>ordersectionsby</code></a> sett'n o' th' ship an' th' planks frontmatter<br/><br/>- <code>weight</code>: t' sort on menu order<br/>- <code>title</code>: t' sort alphabetically on menu label.</td>
<p>Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.</p>
</div>
</div>
<p>This be a demo child plank wit' a hidden child. Ye can still access th' hidden child <ahref="/hugo-theme-relearn/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/">directly</a> or via th' search.</p>
<h2id="subpages-of-this-page">Subpages o' this plank</h2>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">expand</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"Show me almost endless possibilities"</span><spanclass="o">%</span><spanclass="p">}}</span>
<li><em>emphasized</em>, <strong>bold</strong> an' even <strong><em>bold emphasized</em></strong> text</li>
<li><ahref="https://example.com">links</a></li>
<li>etc.</li>
</ul>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code
<tdstyle="text-align:left">When <code>false</code> an' th' included file contains head'ns, th' first head'n will be hidden. This comes 'n handy, eg. if ye include otherwise standalone Marrrkdown files.</td>
<li><em>emphasized</em>, <strong>bold</strong> an' even <strong><em>bold emphasized</em></strong> text</li>
<li><ahref="https://example.com">links</a></li>
<li>etc.</li>
</ul>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code
<p>th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)</p>
<p>Wit' th' <ahref="https://mermaidjs.github.io/">Merrrmaid</a> library an' shorrrtcode, ye can generate diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown.</p>
<p>Due t' limitat'ns wit' <ahref="https://github.com/mermaid-js/mermaid/issues/1846">Merrrmaid</a>, it be currently not poss'ble t' use Merrrmaid code fences 'n an initially collapsed <code>expand</code> shorrrtcode. This be a know issue an' <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/187">can’t be fixed by this theme</a>.</p>
<p>Th' generated graphs can be be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.</p>
<p>While th' examples be us'n shorrrtcode rules it be recommended t' use codefence rules instead. This be because more an' more other software supports Merrrmaid codefences (eg. GitHub) an' so yer markdown becomes more port'ble.</p>
<p>T' use codefence rules ye have t' turn off <code>guessSyntax</code> fer th' <code>marrrkup.highlight</code> sett'n (<ahref="#configuration">see th' configurat'n section</a>).</p>
<p>Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaid’s default sett'ns fer all o' yer files thru a JSON object 'n yer <code>config.toml</code>, override these sett'ns per plank thru yer planks frontmatter or override these sett'n per diagramm thru <ahref="https://mermaid-js.github.io/mermaid/#/directives?id=directives">diagram directives</a>.</p>
<p>Th' JSON object o' yer <code>config.toml</code> / frontmatter be forwarded into Mermaid’s <code>mermaid.initialize()</code> funct'n.</p>
<p>See <ahref="http://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults">Merrrmaid documentat'n</a> fer all allowed sett'ns.</p>
<p>Th' <code>theme</code> sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n <code>config.toml</code>, frontmatter or diagram directives.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># if set t' `guessSyntax = true`, there will be no unstyled code even if no language</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># was given BUT mermaid code fences will not work anymore! So this be a mandatory</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># sett'n fer yer ship</span>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"primary"</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"There may be pirates"</span><spanclass="nx">ay'con</span><spanclass="p">=</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">primary</span><spanclass="s">"There may be pirates"</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<tdstyle="text-align:left">Th' color scheme used t' highlight th' box rrrambl'n.<br/><br/>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br/>- by brand color: <code>primary</code>, <code>secondary</code><br/>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br/>- by special color: <code>default</code>, <code>transparent</code></td>
<tdstyle="text-align:left">Arbitray text fer th' box title. Depend'n on th' <strong>style</strong> there may be a default title. Any given value will overwrite th' default.<br/><br/>- fer severity styles: th' match'n title fer th' severity<br/>- fer all other colors: <em><empty></em><br/><br/>If ye want no title fer a severity style, ye have t' set this parameter t' <code>""</code> (a non empty str'n filled wit' spaces)</td>
<tdstyle="text-align:left"><ahref="/hugo-theme-relearn/pir/cont/icons/#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' title. Depend'n on th' <strong>style</strong> there may be a default ay'con. Any given value will overwrite th' default.<br/><br/>- fer severity styles: a nice match'n ay'con fer th' severity<br/>- fer all other colors: <em><empty></em><br/><br/>If ye want no ay'con fer a severity style, ye have t' set this parameter t' <code>""</code> (a non empty str'n filled wit' spaces)</td>
<li><em>emphasized</em>, <strong>bold</strong> an' even <strong><em>bold emphasized</em></strong> text</li>
<li><ahref="https://example.com">links</a></li>
<li>etc.</li>
</ul>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code
</span></span></code></pre></div><blockquote>
<p>th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work)</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"warning"</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"Here be dragons"</span><spanclass="nx">ay'con</span><spanclass="p">=</span><spanclass="s">"dragon"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"default"</span><spanclass="nx">title</span><spanclass="s">"Pay Attent'n t' this Avast!"</span><spanclass="nx">ay'con</span><spanclass="p">=</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"transparent"</span><spanclass="nx">title</span><spanclass="s">"Pay Attent'n t' this Avast!"</span><spanclass="nx">ay'con</span><spanclass="p">=</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<tdstyle="text-align:left">Th' URL t' th' OpenAPI Specificat'n file. This can be relative t' th' URL o' yer plank if it be a leaf or branch bundle.</td>
<p>Swagger be configured wit' default sett'ns. Ye can cust'mize Swagger’s default sett'ns fer all o' yer files thru a JSON object 'n yer <code>config.toml</code> or override these sett'ns per plank thru yer planks frontmatter.</p>
<p>Th' JSON object o' yer <code>config.toml</code> / frontmatter be forwarded into Swagger’s initializat'n. At th' moment, only th' <code>theme</code> sett'n be supported.</p>
<p>Th' <code>theme</code> sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n <code>config.toml</code> or frontmatter.</p>
<p>Th' <code>tabs</code> shorrrtcode displays arbitrary rrrambl'n 'n unlimited number o' tabs. This comes 'n handy eg. fer provid'n code snippets fer multiple languages or provid'n configurat'n 'n different formats.</p>
<tdstyle="text-align:left">Arbitrary name o' th' group th' tab view belongs t'.<br/><br/>Tab views wit' th' same <strong>groupId</strong> sychr'nize their selected tab. This sychronizat'n applies t' th' whole ship!</td>
<p>When us'n tab views wit' different rrrambl'n sets, make sure t' use a common <code>groupId</code> fer equal sets o' tabs but distinct <code>groupId</code> fer different sets.</p>
<p>Th' tab select'n be restored automatically based on th' <code>groupId</code> an' if it cannot find a tab item because it came from th' <code>'default'</code> group on a different plank then all tabs will be empty at first!</p>
<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>
