mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-27 17:53:07 +00:00
756 lines
74 KiB
HTML
756 lines
74 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="pir" dir="rtl">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
<meta name="generator" content="Hugo 0.112.7">
|
|
<meta name="generator" content="Relearn 5.15.2+tip">
|
|
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
|
<meta name="author" content="Sören Weber">
|
|
<title>What's New :: Cap'n Hugo Relearrrn Theme</title>
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/basics/migration/index.html" rel="alternate" hreflang="x-default">
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/basics/migration/index.html" rel="alternate" hreflang="en">
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/basics/migration/index.html" rel="alternate" hreflang="pir">
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/basics/migration/index.html" rel="canonical" type="text/html" title="What's New :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="../../../pir/basics/migration/index.xml" rel="alternate" type="application/rss+xml" title="What's New :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="../../../images/logo.svg?1685918539" rel="icon" type="image/svg+xml">
|
|
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
|
<link href="../../../css/fontawesome-all.min.css?1685918543" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fontawesome-all.min.css?1685918543" rel="stylesheet"></noscript>
|
|
<link href="../../../css/nucleus.css?1685918543" rel="stylesheet">
|
|
<link href="../../../css/auto-complete.css?1685918543" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/auto-complete.css?1685918543" rel="stylesheet"></noscript>
|
|
<link href="../../../css/perfect-scrollbar.min.css?1685918543" rel="stylesheet">
|
|
<link href="../../../css/fonts.css?1685918543" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fonts.css?1685918543" rel="stylesheet"></noscript>
|
|
<link href="../../../css/theme.css?1685918543" rel="stylesheet">
|
|
<link href="../../../css/theme-auto.css?1685918543" rel="stylesheet" id="variant-style">
|
|
<link href="../../../css/variant.css?1685918543" rel="stylesheet">
|
|
<link href="../../../css/print.css?1685918543" rel="stylesheet" media="print">
|
|
<link href="../../../css/format-print.css?1685918543" rel="stylesheet">
|
|
<link href="../../../css/ie.css?1685918543" rel="stylesheet">
|
|
<script src="../../../js/url.js?1685918543"></script>
|
|
<script src="../../../js/variant.js?1685918543"></script>
|
|
<script>
|
|
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
|
|
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
|
|
window.index_js_url="../../../pir/index.search.js";
|
|
var root_url="../../../";
|
|
var baseUri=root_url.replace(/\/$/, '');
|
|
// translations
|
|
window.T_Copy_to_clipboard = 'Copy t\u0027 clipboard';
|
|
window.T_Copied_to_clipboard = 'Copied t\u0027 clipboard!';
|
|
window.T_Copy_link_to_clipboard = 'Copy link t\u0027 clipboard';
|
|
window.T_Link_copied_to_clipboard = 'Copied link t\u0027 clipboard!';
|
|
window.T_No_results_found = 'No rrresults found fer \u0022{0}\u0022';
|
|
window.T_N_results_found = '{1} rrresults found fer \u0022{0}\u0022';
|
|
// some further base stuff
|
|
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
|
window.variants && variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
|
</script>
|
|
<style>
|
|
#body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../../pir/basics/migration/index.html">
|
|
<div id="body" class="default-animation">
|
|
<div id="sidebar-overlay"></div>
|
|
<div id="toc-overlay"></div>
|
|
<nav id="topbar" class="highlightable">
|
|
<div>
|
|
<div id="breadcrumbs">
|
|
<span id="sidebar-toggle-span">
|
|
<a href="#" id="sidebar-toggle" class="topbar-link" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
|
</span>
|
|
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../../pir/index.html"><span itemprop="name">Cap'n Hugo Relearrrn Theme</span></a><meta itemprop="position" content="1"> > </li>
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../../pir/basics/index.html"><span itemprop="name">Basics</span></a><meta itemprop="position" content="2"> > </li>
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">What's New</span><meta itemprop="position" content="3"></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<main id="body-inner" class="highlightable default" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
<h1 id="whats-new">What's New</h1>
|
|
|
|
|
|
<div class="box notices cstyle warning">
|
|
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Arrr! Pirrrates</div>
|
|
<div class="box-content">
|
|
|
|
<p>Fello' pirrrates, grog made us dizzy! Be awarrre <b>some stuff may not work</b> in this trrranslat'n. Like see'n <b>Merrrmaids</b>, do'n <b>math or chemistrrry</b>, writ'n docs 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' <a href="../../../basics/history/">history plank</a>.</p>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.95.0</span></span> Th' minimum required Cap'n Hugo version.</p>
|
|
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> A change that requires act'n by ye aft upgrad'n t' assure th' ship be still functional.</p>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> A change 'n default behavior that may requires act'n by ye if ye want t' revert it.</p>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Marks new behavior ye might find interest'n or comes configur'ble.</p>
|
|
<!--GH-ACTION-RELEASE-MILESTONE-->
|
|
<hr>
|
|
<h2 id="5150-2023-05-29">5.15.0 (2023-05-29)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Now also compat'ble wit' Cap'n Hugo <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.112.0</span></span> or higher. This does not change th' minimum required Cap'n Hugo version.</p>
|
|
<p>Th' <a href="../../../shortcodes/attachments/"><code>attachments</code> shortcode</a> has compatiblity issues wit' newer Cap'n Hugo versions. Ye must switch t' leaf bundles or be locked t' Cap'n Hugo < <code>0.112.0</code> fer now.</p>
|
|
<p>It be <a href="https://github.com/McShelby/hugo-theme-relearn/issues/22" target="_blank">planned t' refactor</a> th' <code>attchments</code> shortcode 'n th' future. This will make it poss'ble t' use th' shortcode 'n branch bundles again but not 'n simple planks anymore. Sadly this most likely will come wit' a break'n change which requires ye t' make changes t' yer project.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' <a href="../../../shortcodes/tabs/"><code>tabs</code> shortcode</a> has changed behavior if ye haven’t set th' <code>groupid</code> parameter.</p>
|
|
<p>Formerly all tab views without a <code>groupid</code> were treated as so they belong t' th' same group. Now, each tab view be treated as it was given a unique id.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' already known <code>tabs</code>has a new friend th' <a href="../../../shortcodes/tab/"><code>tab</code> shortcode</a> t' make it easier t' create a tab view 'n case ye only need one single tab. Really handy if ye want t' flag yer code examples wit' a language identifier.</p>
|
|
<p>Additionally fer such a use case, th' whitespace between a tab outline an' th' code be removed if only a single code block be contained.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Besides th' <em>tag</em> <a href="../../../cont/taxonomy/">taxonomy</a> th' theme now also provides th' <em>category</em> taxonomy out o' th' box an' shows them 'n th' rrrambl'n footer o' each plank.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="5140-2023-05-20">5.14.0 (2023-05-20)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' taxonomy planks received some love 'n this release, mak'n them better leverage avail'ble screen space an' add'n translat'n support fer th' taxonomy names.</p>
|
|
<p>Hugo’s default taxonmies <code>tags</code> an' <code>categories</code> be already contained 'n th' theme’s i18n files. If ye have self-defined taxonomies, ye can add translat'ns by add'n them t' yer own i18n files. If ye don’t provide translat'ns, th' singualar an' plural forms be taken as configured 'n yer <code>config.toml</code>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> T' give ye more flexibility 'n customiz'n yer article layout a new partial <code>content-header.html</code> be introduced.</p>
|
|
<p>This came out o' th' requirement t' cust'mize th' posit'n o' article tags, which by default be displayed above th' title. A second requirement was t' also show additional <a href="https://gohugo.io/content-management/taxonomies/" target="_blank">taxonomies</a> not supported by th' theme natively. While Cap'n Hugo supports tags an' categories by default, th' theme only displays tags.</p>
|
|
<p>So how t' adjust th' posit'n o' tags start'n from th' theme’s default whar' tags be only shown above th' title?</p>
|
|
<ol>
|
|
<li>Hide tags above title: Overwrite <code>content-header.html</code> wit' an empty file.</li>
|
|
<li>Show tags between title an' rrrambl'n: Overwrite <code>heading-post.html</code> an' add <code>{{- partial "tags.html" . }}</code> t' it.</li>
|
|
<li>Show tags below rrrambl'n: Overwrite <code>content-footer.html</code> an' add <code>{{- partial "tags.html" . }}</code> t' it.</li>
|
|
</ol>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new parameter <code>breadcrumbSeparator</code> be now avail'ble 'n yer <code>config.toml</code> t' change th' - well - separator o' th' breadcrumb items. An appropriate default be 'n place if ye do not configure anyth'n.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="5130-2023-05-17">5.13.0 (2023-05-17)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' <code>swagger</code> shortcode was deprecated 'n favor fer th' <a href="../../../shortcodes/openapi/"><code>openapi</code> shortcode</a>. Ye don’t need t' change anyth'n yet as th' old name will be used as a fallback. It be planned t' remove th' <code>swagger</code> shortcode 'n th' next major release.</p>
|
|
<p>Additionally, th' implemant'n o' this shortcode was switched from RapiDoc t' <a href="https://github.com/swagger-api/swagger-ui" target="_blank">SwaggerUI</a>.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="5120-2023-05-04">5.12.0 (2023-05-04)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed (again). While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Support fer th' great <a href="https://github.com/estruyf/vscode-front-matter" target="_blank">VSCode Front Matter extension</a> which provides on-premise CMS capabilties t' Cap'n Hugo.</p>
|
|
<p>Th' theme provides Front Matter snippets fer its shorrrtcodes. Currently only English an' German be supported. Put a reference into yer <code>frontmatter.json</code> like this</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="err">...</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"frontMatter.extends"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s2">"./vscode-frontmatter/snippets.en.json"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="err">...</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span>
|
|
</span></span></code></pre></div></li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Support fer languages that be written right t' left (like Arabic) be now complete an' extended t' th' menu, th' top navigat'n bar an' print. Ye can experience this 'n th' <a href="../../../pir/basics/migration/">pirate translat'n</a>. This feature be not avail'ble 'n Internet Explorer 11.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' scrollbars be now colored accord'n t' their variant color scheme t' better fit into th' visuals.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="5110-2023-02-07">5.11.0 (2023-02-07)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' theme removed th' popular <a href="https://jquery.com" target="_blank">jQuery</a> library from its distribut'n.</p>
|
|
<p>In case ye made changes t' th' theme that be dependend on this library ye can place a copy o' jQuery into yer <code>static/js</code> directory an' board it from yer own <code>layouts/partials/custom-header.html</code> like this:</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">script</span> <span class="na">src</span><span class="o">=</span><span class="s">"{{"</span><span class="na">js</span><span class="err">/</span><span class="na">jquery</span><span class="err">.</span><span class="na">min</span><span class="err">.</span><span class="na">js</span><span class="err">"|</span> <span class="na">relURL</span><span class="err">}}"</span> <span class="na">defer</span><span class="p">></</span><span class="nt">script</span><span class="p">></span>
|
|
</span></span></code></pre></div></li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> <a href="../../../shortcodes/mermaid/#parameter">Merrrmaid</a> diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.</p>
|
|
<p>Th' default sett'n o' <code>on</code>, 'n effect since 1.1.0, changed back t' <code>off</code> as there was interference wit' scroll'n on mobile an' big planks.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' theme be now cap'ble t' visually <a href="../../../basics/customization/#adjust-to-os-settings">adapt t' yer OS’s light/dark mode sett'n</a>.</p>
|
|
<p>This be also th' new default sett'n if ye haven’t configured <code>themeVariant</code> 'n yer <code>config.toml</code>.</p>
|
|
<p>Additionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new <code>themeVariantAuto</code> parameter.</p>
|
|
<p>This be not supported fer Internet Explorer 11, which still displays 'n th' <code>relearn-light</code> variant.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' JavaScript code fer handl'n image lightboxes (provided by <a href="https://noelboss.github.io/featherlight" target="_blank">Featherlight</a>) was replaced by a CSS-only solut'n.</p>
|
|
<p>This also changed th' <a href="../../../cont/markdown/#lightbox">lightbox effects</a> parameter from <code>featherlight=false</code> t' <code>lightbox=false</code>. Nevertheless ye don’t need t' change anyth'n as th' old name will be used as a fallback.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' <a href="../../../shortcodes/expand/"><code>expand</code> shortcode</a> was changed. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translat'n fer Czech. This language be not supported fer search.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="https://github.com/McShelby/hugo-theme-relearn/tags" target="_blank">GitHub releases</a> be also now tagged fer th' main version (eg. <code>1.2.x</code>), major version (eg. <code>1.x</code>) an' th' latest (just <code>x</code>) release mak'n it easier fer ye t' pin th' theme t' a certain version.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="5100-2023-01-25">5.10.0 (2023-01-25)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../../../shortcodes/attachments/"><code>attachments</code></a>, <a href="../../../shortcodes/badge/"><code>badge</code></a>, <a href="../../../shortcodes/button/"><code>button</code></a> an' <a href="../../../shortcodes/notice/"><code>notice</code></a> shorrrtcodes have a new parameter <code>color</code> t' set arbitrary CSS color values.</p>
|
|
<p>Additionally th' <code>--ACCENT-color</code> brand color introduced 'n version 5.8.0 be now supported wit' these shorrrtcodes.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="590-2022-12-23">5.9.0 (2022-12-23)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> Wit' this version it be now poss'ble t' not only have sections on th' first menu level but also planks.</p>
|
|
<p>It was later discovered, that this causes planks only meant t' be displayed 'n th' <code>More</code> section o' th' menu an' stored directly inside yer <code>rrrambl'n</code> directory t' now show up 'n th' menu aswell.</p>
|
|
<p>T' get rid o' this undesired behavior ye have two choices:</p>
|
|
<ol>
|
|
<li>
|
|
<p>Make th' plank file fer th' <code>More</code> section a <a href="https://gohugo.io/content-management/page-bundles/#headless-bundle" target="_blank">headless branch bundle</a> (contained 'n its own subdirectory an' called <code>_index.md</code>) an' add th' follow'n frontmatter configurat'n t' th' file (see exampleSite’s <code>content/showcase</code>). This causes its rrrambl'n t' <strong>not</strong> be contained 'n th' sitemap.</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s2">"never"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">list</span> <span class="p">=</span> <span class="s2">"never"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">publishResources</span> <span class="p">=</span> <span class="kc">false</span>
|
|
</span></span></code></pre></div></li>
|
|
<li>
|
|
<p>Store th' plank file fer th' <code>More</code> section below a parent headless branch bundle an' add th' follow'n frontmatter t' th' <strong>parent</strong>. In this case, th' file itself can be a branch bundle, leaf bundle or simple plank (see exampleSite’s <code>content/more/</code> an' <code>content/more/credits</code>). This causes its rrrambl'n t' be contained 'n th' sitemap.</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">_build</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">render</span> <span class="p">=</span> <span class="s2">"always"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">list</span> <span class="p">=</span> <span class="s2">"never"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">publishResources</span> <span class="p">=</span> <span class="kc">true</span>
|
|
</span></span></code></pre></div></li>
|
|
</ol>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' required folder name fer th' <a href="../../../shortcodes/attachments/"><code>attachments</code> shortcode</a> was changed fer leaf bundles.</p>
|
|
<p>Previously, th' attachments fer leaf bundles 'n non-multilang setups were required t' be 'n a <code>files</code> subdirectory. For plank bundles an' leaf bundles 'n multilang setups they were always required t' be 'n a <code>_index.<LANGCODE>.files</code> or <code>index.<LANGCODE>.files</code> subdirectory accordingly.</p>
|
|
<p>This added unnessessary complexity. So attachments fer leaf bundles 'n non-multilang setups can now also reside 'n a <code>index.files</code> directory. Although th' old <code>files</code> directory be now deprecated, if both directories be present, only th' old <code>files</code> directory will be used fer compatiblity.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Absolute links prefixed wit' <code>http://</code> or <code>https://</code> be now opened 'n a separate browser tab.</p>
|
|
<p>Ye can revert back t' th' old behavior by defin'n <code>externalLinkTarget="_self"</code> 'n th' <code>params</code> section o' yer <code>config.toml</code>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme now supports <a href="https://gohugo.io/hugo-modules/" target="_blank">Hugo’s module system</a>.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="580-2022-12-08">5.8.0 (2022-12-08)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new <a href="../../../shortcodes/badge/"><code>badge</code> shortcode</a> be now avail'ble t' add highly configur'ble markers t' yer rrrambl'n as ye can see it on this plank.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new <a href="../../../shortcodes/icon/"><code>ay'con</code> shortcode</a> simplyfies th' usage o' ay'cons. This can even be combined wit' also new <code>badge</code> shortcode.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme now supports some o' GFM (GitHub Flavored Markdown) rules an' Cap'n Hugo Marrrkdown extensions, namely <a href="../../../cont/markdown/#tasks">task lists</a>, <a href="../../../cont/markdown/#defintions">defint'n lists</a> an' <a href="../../../cont/markdown/#footnotes">footnotes</a>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> A new color <code>--ACCENT-color</code> was introduced which be used fer highlightn'n search results on th' plank. In case ye simply don’t care, ye don’t need t' change anyth'n 'n yer variant stylesheet as th' old <code>yellow</code> color be still used as default.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="570-2022-11-29">5.7.0 (2022-11-29)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' Korean language translat'n fer this theme be now avail'ble wit' th' language code <code>ko</code>. Formerly th' country code <code>kr</code> was used instead.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../../../shortcodes/button/"><code>button</code> shortcode</a> can now also be used as a real button inside o' HTML forms - although this be a pretty rare use case. Th' documentat'n was updated accordingly.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' search now supports th' Korean language.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="560-2022-11-18">5.6.0 (2022-11-18)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> This release introduces an additional dedicated search plank. On this plank, displayed search results have more space mak'n it easier scann'n thru large number o' results.</p>
|
|
<p>T' activate this feature, ye need t' <a href="../../../basics/configuration/#activate-dedicated-search-page">configure it</a> 'n yer <code>config.toml</code> as a new outputformat <code>SEARCHPAGE</code> fer th' home plank. If ye don’t configure it, no dedicated search plank will be access'ble an' th' theme works as before.</p>
|
|
<p>Ye can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Keyboard handl'n fer th' TOC an' search was improved.</p>
|
|
<p>Press'n <code>CTRL+ALT+t</code> now will not only toggle th' TOC overlay but also places th' focus t' th' first head'n on open'n. Subsequently this makes it poss'ble t' easily select head'ns by us'n th' <code>TAB</code> key.</p>
|
|
<p>Th' search received its own brand new keyboard shortcut <code>CTRL+ALT+f</code>. This will focus th' cursor inside o' th' the search box so ye can immediately start yer search by typ'n.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Ye be now able t' turn off th' generat'n o' generator meta tags 'n yer HTML head t' hide th' used versions o' Cap'n Hugo an' this theme.</p>
|
|
<p>T' <a href="../../../basics/configuration/#global-site-parameters">configure this</a> 'n yer <code>config.toml</code> make sure t' set Hugo’s <code>disableHugoGeneratorInject=true</code> <strong>an'</strong> also <code>[params] disableGeneratorVersion=true</code>, otherwise Cap'n Hugo will generate a meta tag into yer home plank automagically.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Creat'n o' yer project gets a little bit faster wit' this release.</p>
|
|
<p>This addresses increased build time wit' th' 5.x releases. Th' theme now heavily caches partial results lead'n t' improved performance. T' further increase performance, unnecessary parts o' th' plank be now skipped fer creat'n o' th' print output (eg. menus, navigat'n bar, etc.).</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="550-2022-11-06">5.5.0 (2022-11-06)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' way images be processed has changed. Now images be lazy boarded by default which speeds up plank board on slow networks and/or big planks an' also th' print preview.</p>
|
|
<p>For that th' JavaScript code t' handle th' <a href="../../../cont/markdown/#further-image-formatting">lightbox an' image effects</a> on th' client side was removed 'n favour fer static generat'n o' those effects on th' server.</p>
|
|
<p>If ye have used HTML directly 'n yer Marrrkdown files, this now has th' downside that it doesn’t respect th' effect query parameter anymore. In this case ye have t' migrate all yer HTML <code>img</code> URLs manually t' th' respective HTML attributes.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Old</th>
|
|
<th>New</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code><img src="pic.png?width=20vw&classes=shadow,border"></code></td>
|
|
<td><code><img src="pic.png" style="width:20vw;" class="shadow border"></code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="540-2022-11-01">5.4.0 (2022-11-01)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> <a href="../../../basics/configuration/#serving-your-page-from-the-filesystem">Wit' th' proper sett'ns</a> 'n yer <code>config.toml</code> yer plank be now serv'ble from th' local file system us'n <code>file://</code> URLs.</p>
|
|
<p>Please note that th' searchbox will only work fer this if ye reconfigure yer outputformat fer th' homepage 'n yer <code>config.toml</code> from <code>JSON</code> t' <code>SEARCH</code>. Th' now deprecated <code>JSON</code> outputformat still works as before, so there be no need t' reconfigure yer installat'n if it be only served from <code>http://</code> or <code>https://</code>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' <a href="../../../shortcodes/button/"><code>button</code> shortcode</a> has a new parameter <code>target</code> t' set th' destinat'n frame/window fer th' URL t' open. If not given, it defaults t' a new window/tab fer external URLs or be not set at all fer internal URLs. Previously even internal URLs whar' opened 'n a new window/tab.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../../../shortcodes/math/"><code>math</code> shortcode</a> an' <a href="../../../shortcodes/mermaid/"><code>mermaid</code> shortcode</a> now also support th' <code>align</code> parameter if codefence rules be used.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Support fer languages that be written right t' left (like Arabic). This be only implemented fer th' rrrambl'n area but not th' navigat'n sidebar. This feature be not avail'ble 'n Internet Explorer 11.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translat'n fer Finnish (Suomi).</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="530-2022-10-07">5.3.0 (2022-10-07)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Th' functionality o' th' new implementat'n does not work wit' old browsers (Internet Explorer 11).</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="../../../cont/markdown/#add-css-classes">Image formatt'n</a> has two new classes t' align images t' th' <code>left</code> or <code>right</code>. Additionally, th' already exist'n <code>inline</code> opt'n be now documented.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Print'n fer th' <a href="../../../shortcodes/openapi/"><code>swagger</code> shortcode</a> was optimized t' expand sections that be usually closed 'n interactive mode. This requires <a href="../../../basics/configuration/#activate-print-support">print support</a> t' be configured.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="520-2022-08-03">5.2.0 (2022-08-03)</h2>
|
|
<ul>
|
|
<li><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> If you’ve set <code>collapsibleMenu = true</code> 'n yer <code>config.toml</code>, th' menu will be expanded if a search term be found 'n a collapsed submenu. Th' menu will return t' its initial collapse state once th' search term does not match any submenus.</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="510-2022-07-15">5.1.0 (2022-07-15)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.95.0</span></span> This release requires a newer Cap'n Hugo version.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a <code>index.print.html</code> t' th' default URL.</p>
|
|
<p>Ye can revert this behavior by overwrit'n th' PRINT output format sett'n 'n yer <code>config.toml</code>t':</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">outputFormats</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">outputFormats</span><span class="p">.</span><span class="nx">PRINT</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">name</span><span class="p">=</span> <span class="s2">"PRINT"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">baseName</span> <span class="p">=</span> <span class="s2">"index"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">path</span> <span class="p">=</span> <span class="s2">"_print"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">isHTML</span> <span class="p">=</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">mediaType</span> <span class="p">=</span> <span class="s1">'text/html'</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">permalink'ble</span> <span class="p">=</span> <span class="kc">false</span>
|
|
</span></span></code></pre></div></li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="500-2022-07-05">5.0.0 (2022-07-05)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case you’ve added own JavaScript code that depends on th' themes jQuery implementat'n, ye have t' put it into a separate <code>*.js</code> file (if not already) an' add th' <code>defer</code> keyword t' th' <code>script</code> element. Eg.</p>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">script</span> <span class="na">defer</span> <span class="na">src</span><span class="o">=</span><span class="s">"myscript.js"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span>
|
|
</span></span></code></pre></div></li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' way <a href="../../../cont/archetypes/">archetypes</a> be used t' generate output has changed. Th' new systems allows ye, t' redefine exist'n archetypes or even generate yer own ones.</p>
|
|
<p>Yer exist'n markdown files will still work like before an' therefore ye don’t need t' change anyth'n aft th' upgrade. Nevertheless, it be recommended t' adapt yer exist'n markdown files t' th' new way as follows:</p>
|
|
<ul>
|
|
<li>
|
|
<p>fer yer home plank, add th' frontmatter parameter <code>archetype = "home"</code> an' remove th' lead'n head'n</p>
|
|
</li>
|
|
<li>
|
|
<p>fer all files contain'n th' deprecated frontmatter parameter <code>chapter = true</code>, replace it wit' <code>archetype = "chapter"</code> an' remove th' lead'n head'ns</p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' frontmatter opt'ns <code>pre</code> / <code>post</code> were renamed t' <code>menuPre</code> / <code>menuPost</code>. Th' old opt'ns will still be used if th' new opt'ns aren’t set. Therefore ye don’t need t' change anyth'n aft th' upgrade.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Add'n new partials <code>heading-pre.html</code> / <code>heading-post.html</code> an' accord'n frontmatter opt'ns <code>headingPre</code> / <code>headingPost</code> t' modify th' way yer page`s main head'n gets styled.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new shortcode <code>math</code> be avail'ble t' add beautiful math an' chemical formulae. See th' <a href="../../../shortcodes/math/">documentat'n</a> fer avail'ble features. This feature will not work wit' Internet Explorer 11.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="420-2022-06-23">4.2.0 (2022-06-23)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> Th' second parameter fer th' <a href="../../../shortcodes/include/"><code>include</code> shortcode</a> was switched 'n mean'n an' was renamed from <code>showfirsthead'n</code> t' <code>hidefirsthead'n</code>. If ye haven’t used this parameter 'n yer shortcode, th' default behavior hasn’t changed an' ye don’t need t' change anyth'n.</p>
|
|
<p>If you’ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Previously, if th' <a href="../../../shortcodes/tabs/"><code>tabs</code> shortcode</a> could not find a tab item because, th' tabs ended up empty. Now th' first tab be selected instead.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Th' <code>landingPageURL</code> was removed from <code>config.toml</code>. Ye can safely remove this as well from yer configurat'n as it be not used anymore. Th' theme will detect th' land'n plank URL automatically.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shortcode.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="410-2022-06-12">4.1.0 (2022-06-12)</h2>
|
|
<ul>
|
|
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> While fix'n issues wit' th' search functionality fer non Latin languages, ye can now <a href="../../../cont/i18n/#search-with-mixed-language-support">configure t' have multiple languages on a single plank</a>.</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="400-2022-06-05">4.0.0 (2022-06-05)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> Th' <code>custom_css</code> config parameter was removed from th' configurat'n. If used 'n an exist'n installat'n, it can be achieved by overrid'n th' <code>custom-header.html</code> template 'n a much more generic manner.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> Because anchor hover color was not configur'ble without introduc'n more complexity t' th' variant stylesheets, we decided t' remove <code>--MAIN-ANCHOR-color</code> instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' anchors now get their colors from <code>--MAIN-LINK-color</code> an' <code>--MAIN-ANCHOR-HOVER-color</code> respectively.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’t need t' change anyth'n 'n yer installat'n.</p>
|
|
<p>This applies t' <a href="../../../shortcodes/expand/"><code>expand</code></a>, <a href="../../../shortcodes/include/"><code>include</code></a>, <a href="../../../shortcodes/notice/"><code>notice</code></a> an' <a href="../../../shortcodes/siteparam/"><code>siteparam</code></a>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' <a href="../../../shortcodes/button/"><code>button</code></a> shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New colors <code>--PRIMARY-color</code> an' <code>--SECONDARY-color</code> were added t' provide easier modificat'n o' yer custom style. Shorrrtcodes wit' a color style can now have <code>primary</code> or <code>secondary</code> as additional values.</p>
|
|
<p>These two colors be th' default fer other, more specific color variables. Ye don’t need t' change anyth'n 'n yer exist'n custom color stylesheets as those variables get reason'ble default values.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translat'n fer Polish. This language be not supported fer search.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' documentat'n fer all shorrrtcodes were revised.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="340-2022-04-03">3.4.0 (2022-04-03)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> If ye had previously overwritten th' <code>custom-footer.html</code> partial t' add visual elements below th' rrrambl'n o' yer plank, ye have t' move this rrrambl'n t' th' new partial <code>content-footer.html</code>. <code>custom-footer.html</code> was never meant t' contain HTML other than additional styles an' JavaScript.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> If ye prefer expandable/collaps'ble menu items, ye can now set <code>collapsibleMenu=true</code> 'n yer <code>config.toml</code>. This will add arrows t' all menu items that contain sub menus. Th' menu will expand/collapse without navigat'n if ye click on an arrow.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Ye can activate <a href="../../../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>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Translat'n fer Traditional Chinese.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="330-2022-03-28">3.3.0 (2022-03-28)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishes between <code>--MAIN-font</code> fer all rrrambl'n text an' <code>--CODE-font</code> fer inline or block code. There be additional overrides fer all head'ns. See th' <a href="../../../basics/generator/">theme variant generator</a> o' th' exampleSite fer all avail'ble variables.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' new shortcode <code>swagger</code> be avail'ble t' include a UI fer REST OpenAPI specificat'ns. See th' <a href="../../../shortcodes/openapi/">documentat'n</a> fer avail'ble features. This feature will not work wit' Internet Explorer 11.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="320-2022-03-19">3.2.0 (2022-03-19)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.93.0</span></span> This release requires a newer Cap'n Hugo version.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shortcode or be us'n Merrrmaid codefences. This changes th' behavior o' <code>disableMermaid</code> config opt'n as follows: If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.</p>
|
|
<p>Th' opt'n be still useful 'n case ye be us'n script'n t' set up yer graph. In this case no shortcode or codefence be involved an' th' library be not boarded by default. In this case ye can set <code>disableMermaid=false</code> 'n yer frontmatter t' force th' library t' be boarded. See th' <a href="../../../basics/generator/">theme variant generator</a> o' th' exampleSite fer an example.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Additional color variant vari'ble <code>--MERMAID-theme</code> t' set th' variant’s Merrrmaid theme. This causes th' Merrrmaid theme t' switch wit' th' color variant if it defers from th' sett'n o' th' formerly selected color variant.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="310-2022-03-15">3.1.0 (2022-03-15)</h2>
|
|
<ul>
|
|
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="../../../shortcodes/attachments/"><code>attachment</code></a> an' <a href="../../../shortcodes/notice/"><code>notice</code></a> shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all <a href="https://fontawesome.com/v5/search?m=free" target="_blank">Font Awesome 5 Free</a> ay'cons.</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="300-2022-02-22">3.0.0 (2022-02-22)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> We made changes t' th' menu footer. If ye have yer <code>menu-footer.html</code> <a href="../../../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><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> We have changed th' default colors from th' original Learrrn theme (the purple menu header) t' th' Relearrrn defaults (the light green menu header) as used 'n th' official documentat'n.</p>
|
|
<p>This change will only affect yer installat'n if you’ve not set th' <code>themeVariant</code> parameter 'n yer <code>config.toml</code>. <a href="../../../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>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Due t' a bug, that we couldn’t fix 'n a general manner fer color variants, we decided t' remove <code>--MENU-SEARCH-BOX-ICONS-color</code> an' introduced <code>--MENU-SEARCH-color</code> instead. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> For consistency reasons, we renamed <code>--MENU-SEARCH-BOX-color</code> t' <code>--MENU-SEARCH-BORDER-color</code>. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Wit' this release ye be now cap'ble t' define yer own <em>dark mode</em> variants.</p>
|
|
<p>T' make this poss'ble, we have introduced a lot more color variables ye can use 'n <a href="../../../basics/customization/#theme-variant">yer color variants</a>. Yer old variants will still work an' don’t need t' be changed as appropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.</p>
|
|
<p>T' see what’s now poss'ble, see th' new variants <code>relearn-dark</code> an' <code>neon</code> that be com'n wit' this release.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> T' make th' creat'n o' new variants easier fer ye, we’ve added a new interactive <a href="../../../basics/generator/">theme variant generator</a>. This feature will not work wit' Internet Explorer 11.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Ye can now configure multiple color variants 'n yer <code>config.toml</code>. In this case, th' first variant be th' default chosen on first view an' a variant switch will be shown 'n th' menu footer. See th' <a href="../../../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>
|
|
<h2 id="290-2021-11-19">2.9.0 (2021-11-19)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> This release removes th' themes implementat'n o' <code>ref</code>/<code>relref</code> 'n favor fer Hugos standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard compliant an' exchang'n this theme 'n yer project t' some other theme will be effortless.</p>
|
|
<p>In a standard compliant form ye must not link t' th' <code>*.md</code> file but t' its logical name. You’ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Non-Standard</th>
|
|
<th>Standard</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Branch bundle</td>
|
|
<td><code>basics/configuration/_index.md</code></td>
|
|
<td><code>basics/configurat'n</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Leaf bundle</td>
|
|
<td><code>basics/configuration/index.md</code></td>
|
|
<td><code>basics/configurat'n</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Plank</td>
|
|
<td><code>basics/configurat'n.md</code></td>
|
|
<td><code>basics/configurat'n</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>If you’ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version" target="_blank">Cap'n Hugo got ye covered</a> as well.</p>
|
|
<p>Also, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugos implementat'n t' show th' error below an' abort th' generat'n. If yer project relies on this old behavior, ye can <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version" target="_blank">reconfigure th' error handl'n</a> o' Hugos implementat'n.</p>
|
|
<p>In th' best case yer usage o' th' old implementat'n be already standard compliant an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started <code>hugo server</code> 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>
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">ERROR 2021/11/19 22:29:10 <span class="o">[</span>en<span class="o">]</span> REF_NOT_FOUND: Ref <span class="s2">"basics/configuration/_index.md"</span>: <span class="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>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>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Search</th>
|
|
<th>Replace by</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Branch bundle</td>
|
|
<td><code>(ref\s+"[^"]*)/_index\.md"</code></td>
|
|
<td><code>$1"</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Leaf bundle</td>
|
|
<td><code>(ref\s+"[^"]*)/index\.md"</code></td>
|
|
<td><code>$1"</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Plank</td>
|
|
<td><code>(ref\s+"[^"]*)\.md"</code></td>
|
|
<td><code>$1"</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</li>
|
|
<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>
|
|
</ol>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="280-2021-11-03">2.8.0 (2021-11-03)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Although never officially documented, this release removes th' font <code>Novacento</code>/<code>Novecento</code>. If ye use it 'n an overwritten CSS please replace it wit' <code>Work Sans</code>. This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer Czech.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' theme now supports favicons served from <code>static/images/</code> named as <code>favicon</code> or <code>logo</code> 'n SVG, PNG or ICO format <a href="../../../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><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' <code>disableToc</code> opt'n 'n yer <code>config.toml</code>. For an example see <a href="../../../basics/configuration/#global-site-parameters">th' example configurat'n</a>.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="270-2021-10-24">2.7.0 (2021-10-24)</h2>
|
|
<ul>
|
|
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Optional second parameter fer <a href="../../../shortcodes/notice/"><code>notice</code></a> shortcode t' set title 'n box header.</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="260-2021-10-21">2.6.0 (2021-10-21)</h2>
|
|
<ul>
|
|
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Yer ship can now be served from a subfolder if ye set <code>baseURL</code> an' <code>canonifyURLs=true</code> 'n yer <code>config.toml</code>. See th' <a href="../../../basics/configuration/#a-word-on-running-your-site-in-a-subfolder">documentat'n</a> fer a detailed example.</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="250-2021-10-08">2.5.0 (2021-10-08)</h2>
|
|
<ul>
|
|
<li><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> New colors <code>--CODE-BLOCK-color</code> an' <code>--CODE-BLOCK-BG-color</code> were added t' provide a fallback fer Hugos rules highlight'n 'n case <code>guessSyntax=true</code> be set. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style.</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="240-2021-10-07">2.4.0 (2021-10-07)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n <code>disableTagHiddenPages=true</code> 'n yer <code>config.toml</code>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' <code>alwaysopen</code> opt'n 'n yer <code>config.toml</code>. Please see further <a href="../../../cont/pages/#override-expand-state-rules-for-menu-entries">documentat'n</a> fer poss'ble values an' default behavior.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New frontmatter <code>ordersectionsby</code> opt'n t' change immediate children sort'n 'n menu an' <code>children</code> shortcode. Poss'ble values be <code>title</code> or <code>weight</code>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See <a href="https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head" target="_blank">Cap'n Hugo documentat'n</a>.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="230-2021-09-13">2.3.0 (2021-09-13)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.81.0</span></span> This release requires a newer Cap'n Hugo version.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Showcase multilanguage features by provid'n a documentat'n translat'n “fer us pirrrates”. There will be no other translat'ns besides th' original English one an' th' Pirates one due t' maintenance constraints.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="220-2021-09-09">2.2.0 (2021-09-09)</h2>
|
|
<ul>
|
|
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Hidden planks be displayed by default 'n th' sitemap generated by Cap'n Hugo an' be therefore vis'ble fer search engine index'n. Ye can now turn off this behavior by sett'n <code>disableSeoHiddenPages=true</code> 'n yer <code>config.toml</code>.</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="210-2021-09-07">2.1.0 (2021-09-07)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.69.0</span></span> This release requires a newer Cap'n Hugo version.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In case th' site’s structure contains additional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see <code>CHANGELOG.md</code> 'n th' exampleSite), they will now be ignored by th' search.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n <code>disableSearchHiddenPages=true</code> 'n yer <code>config.toml</code>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> If a search term be found 'n an <code>expand</code> shortcode, th' expand will be opened.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Th' menu will scroll th' active item into view on board.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="200-2021-08-28">2.0.0 (2021-08-28)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Rules highlight'n was switched t' th' <a href="https://gohugo.io/content-management/syntax-highlighting/" target="_blank">built 'n Hugo mechanism</a>. Ye may need t' configure a new stylesheet or decide t' roll ye own as described on 'n th' Cap'n Hugo documentat'n</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> In th' predefined stylesheets there was a typo an' <code>--MENU-HOME-LINK-HOVERED-color</code> must be changed t' <code>--MENU-HOME-LINK-HOVER-color</code>. Ye don’t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> <code>--MENU-HOME-LINK-color</code> an' <code>--MENU-HOME-LINK-HOVER-color</code> were miss'n 'n th' documentat'n. Ye should add them t' yer custom stylesheets if ye want t' override th' defaults.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> Arrow navigat'n an' <code>children</code> shortcode were ignor'n sett'n fer <code>ordersectionsby</code>. This be now changed an' may result 'n different sort'n order o' yer sub planks.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle note badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-circle"></i></span><span class="badge-content">Change</span></span> A plank without a <code>title</code> will be treated as <code>hidden=true</code>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further <a href="../../../cont/pages/#override-expand-state-rules-for-menu-entries">documentat'n</a> fer poss'ble values an' default behavior.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See <a href="../../../basics/customization/">documentat'n</a> fer further read'n.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Shortcode <a href="../../../shortcodes/children/"><code>children</code></a> wit' new parameter <code>containerstyle</code>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> New shortcode <a href="../../../shortcodes/include/"><code>include</code></a> t' include arbitrary file rrrambl'n into a plank.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="120-2021-07-26">1.2.0 (2021-07-26)</h2>
|
|
<ul>
|
|
<li><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Shortcode <a href="../../../shortcodes/expand/"><code>expand</code></a> wit' new parameter t' open on plank board.</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="110-2021-07-02">1.1.0 (2021-07-02)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Break'n</span></span> <a href="../../../shortcodes/mermaid/">Merrrmaid</a> diagrams can now be panned an' zoomed. This isn’t configur'ble yet.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> <a href="../../../shortcodes/mermaid/#configuration"><code>Merrrmaid</code></a> config opt'ns can be set 'n <code>config.toml</code>.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="100-2021-07-01">1.0.0 (2021-07-01)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.65.0</span></span> Th' requirement fer th' Cap'n Hugo version o' this theme be th' same as fer th' Learrrn theme version 2.5.0 on 2021-07-01.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-plus-circle"></i></span><span class="badge-content">New</span></span> Initial fork o' th' <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learrrn theme</a> based on Learrrn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename t' <code>Relearrrn</code> an' a new logo. For th' reasons behind fork'n th' Learrrn theme, see <a href="https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495" target="_blank">this comment</a> 'n th' Learrrn issues.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<footer class="footline">
|
|
|
|
</footer>
|
|
</article>
|
|
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="../../../js/clipboard.min.js?1685918543" defer></script>
|
|
<script src="../../../js/perfect-scrollbar.min.js?1685918543" defer></script>
|
|
<script src="../../../js/theme.js?1685918543" defer></script>
|
|
</body>
|
|
</html>
|