mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-24 00:03:10 +00:00
656 lines
63 KiB
HTML
656 lines
63 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr">
|
|
<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.110.0">
|
|
<meta name="generator" content="Relearn 5.11.2+tip">
|
|
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
|
<meta name="author" content="Sören Weber">
|
|
<title>What's New :: Hugo Relearn 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/basics/migration/index.html" rel="canonical" type="text/html" title="What's New :: Hugo Relearn Theme">
|
|
<link href="../../basics/migration/index.xml" rel="alternate" type="application/rss+xml" title="What's New :: Hugo Relearn Theme">
|
|
<link href="../../images/logo.svg?1676046693" 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?1676046695" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1676046695" rel="stylesheet"></noscript>
|
|
<link href="../../css/nucleus.css?1676046695" rel="stylesheet">
|
|
<link href="../../css/auto-complete.css?1676046695" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1676046695" rel="stylesheet"></noscript>
|
|
<link href="../../css/perfect-scrollbar.min.css?1676046695" rel="stylesheet">
|
|
<link href="../../css/fonts.css?1676046695" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1676046695" rel="stylesheet"></noscript>
|
|
<link href="../../css/theme.css?1676046695" rel="stylesheet">
|
|
<link href="../../css/theme-auto.css?1676046695" rel="stylesheet" id="variant-style">
|
|
<link href="../../css/variant.css?1676046695" rel="stylesheet">
|
|
<link href="../../css/print.css?1676046695" rel="stylesheet" media="print">
|
|
<link href="../../css/format-print.css?1676046695" rel="stylesheet">
|
|
<link href="../../css/ie.css?1676046695" rel="stylesheet">
|
|
<script src="../../js/url.js?1676046695"></script>
|
|
<script src="../../js/variant.js?1676046695"></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="../../index.search.js";
|
|
var root_url="../../";
|
|
var baseUri=root_url.replace(/\/$/, '');
|
|
// translations
|
|
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
|
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
|
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
|
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
|
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
|
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
|
// some further base stuff
|
|
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
|
window.variants && variants.init( [ 'auto', '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="../../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="../../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li>
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../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">
|
|
<div id="head-tags">
|
|
</div>
|
|
<article class="default">
|
|
<h1 id="whats-new">What's New</h1>
|
|
|
|
<p>This document shows you what’s new in the latest release. For a detailed list of changes, see the <a href="../../basics/history/">history page</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> The minimum required 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">Breaking</span></span> A change that requires action by you after upgrading to assure the site is 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 in default behavior that may requires action by you if you want to 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 you might find interesting or comes configurable.</p>
|
|
<!--GH-ACTION-RELEASE-MILESTONE-->
|
|
<hr>
|
|
<h2 id="5120-not-yet-released">5.12.0 (not yet released)</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> Support for languages that are written right to left (like Arabic) is now complete and extended to the menu, the top navigation bar and print. This feature is not available in Internet Explorer 11.</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> The theme removed the popular <a href="https://jquery.com" target="_blank">jQuery</a> library from its distribution.</p>
|
|
<p>In case you made changes to the theme that are dependend on this library you can place a copy of jQuery into your <code>static/js</code> directory and load it from your 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">if</span> <span class="err">$</span><span class="na">assetBusting</span> <span class="err">}}?{{</span> <span class="na">now</span><span class="err">.</span><span class="na">Unix</span> <span class="err">}}{{</span> <span class="na">end</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">Mermaid</a> diagrams can now be configured for pan and zoom on site-, page-level or individually for each graph.</p>
|
|
<p>The default setting of <code>on</code>, in effect since 1.1.0, changed back to <code>off</code> as there was interference with scrolling on mobile and big pages.</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> The theme is now capable to visually <a href="../../basics/customization/#adjust-to-os-settings">adapt to your OS’s light/dark mode setting</a>.</p>
|
|
<p>This is also the new default setting if you haven’t configured <code>themeVariant</code> in your <code>config.toml</code>.</p>
|
|
<p>Additionally you can configure the variants to be taken for light/dark mode with the new <code>themeVariantAuto</code> parameter.</p>
|
|
<p>This is not supported for Internet Explorer 11, which still displays in the <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> The JavaScript code for handling image lightboxes (provided by <a href="https://noelboss.github.io/featherlight" target="_blank">Featherlight</a>) was replaced by a CSS-only solution.</p>
|
|
<p>This also changed the <a href="../../cont/markdown/#lightbox">lightbox effects</a> parameter from <code>featherlight=false</code> to <code>lightbox=false</code>. Nevertheless you don’t need to change anything as the 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 the effort to comply with WCAG standards, the implementation of the <a href="../../shortcodes/expand/"><code>expand</code> shortcode</a> was changed. While Internet Explorer 11 has issues in displaying it, the 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> Translation for Czech. This language is not supported for 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> are also now tagged for the main version (eg. <code>1.2.x</code>), major version (eg. <code>1.x</code>) and the latest (just <code>x</code>) release making it easier for you to pin the theme to 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> The <a href="../../shortcodes/attachments/"><code>attachments</code></a>, <a href="../../shortcodes/badge/"><code>badge</code></a>, <a href="../../shortcodes/button/"><code>button</code></a> and <a href="../../shortcodes/notice/"><code>notice</code></a> shortcodes have a new parameter <code>color</code> to set arbitrary CSS color values.</p>
|
|
<p>Additionally the <code>--ACCENT-color</code> brand color introduced in version 5.8.0 is now supported with these shortcodes.</p>
|
|
</li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="590-2022-12-23">5.9.0 (2022-12-23)</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> The required folder name for the <a href="../../shortcodes/attachments/"><code>attachments</code> shortcode</a> was changed for leaf bundles.</p>
|
|
<p>Previously, the attachments for leaf bundles in non-multilang setups were required to be in a <code>files</code> subdirectory. For page bundles and leaf bundles in multilang setups they were always required to be in a <code>_index.<LANGCODE>.files</code> or <code>index.<LANGCODE>.files</code> subdirectory accordingly.</p>
|
|
<p>This added unnessessary complexity. So attachments for leaf bundles in non-multilang setups can now also reside in a <code>index.files</code> directory. Although the old <code>files</code> directory is now deprecated, if both directories are present, only the old <code>files</code> directory will be used for 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 with <code>http://</code> or <code>https://</code> are now opened in a separate browser tab.</p>
|
|
<p>You can revert back to the old behavior by defining <code>externalLinkTarget="_self"</code> in the <code>params</code> section of your <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> The 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> The new <a href="../../shortcodes/badge/"><code>badge</code> shortcode</a> is now available to add highly configurable markers to your content as you can see it on this page.</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> The new <a href="../../shortcodes/icon/"><code>icon</code> shortcode</a> simplyfies the usage of icons. This can even be combined with 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> The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely <a href="../../cont/markdown/#tasks">task lists</a>, <a href="../../cont/markdown/#defintions">defintion lists</a> and <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 is used for highlightning search results on the page. In case you simply don’t care, you don’t need to change anything in your variant stylesheet as the old <code>yellow</code> color is 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> The Korean language translation for this theme is now available with the language code <code>ko</code>. Formerly the 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> The <a href="../../shortcodes/button/"><code>button</code> shortcode</a> can now also be used as a real button inside of HTML forms - although this is a pretty rare use case. The documentation 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> The search now supports the 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 page. On this page, displayed search results have more space making it easier scanning thru large number of results.</p>
|
|
<p>To activate this feature, you need to <a href="../../basics/configuration/#activate-dedicated-search-page">configure it</a> in your <code>config.toml</code> as a new outputformat <code>SEARCHPAGE</code> for the home page. If you don’t configure it, no dedicated search page will be accessible and the theme works as before.</p>
|
|
<p>You can access the search page by either clicking on the magnifier glass or pressing enter inside of the 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 handling for the TOC and search was improved.</p>
|
|
<p>Pressing <code>CTRL+ALT+t</code> now will not only toggle the TOC overlay but also places the focus to the first heading on opening. Subsequently this makes it possible to easily select headings by using the <code>TAB</code> key.</p>
|
|
<p>The search received its own brand new keyboard shortcut <code>CTRL+ALT+f</code>. This will focus the cursor inside of the the search box so you can immediately start your search by typing.</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> You are now able to turn off the generation of generator meta tags in your HTML head to hide the used versions of Hugo and this theme.</p>
|
|
<p>To <a href="../../basics/configuration/#global-site-parameters">configure this</a> in your <code>config.toml</code> make sure to set Hugo’s <code>disableHugoGeneratorInject=true</code> <strong>and</strong> also <code>[params] disableGeneratorVersion=true</code>, otherwise Hugo will generate a meta tag into your home page 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> Creation of your project gets a little bit faster with this release.</p>
|
|
<p>This addresses increased build time with the 5.x releases. The theme now heavily caches partial results leading to improved performance. To further increase performance, unnecessary parts of the page are now skipped for creation of the print output (eg. menus, navigation 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> The way images are processed has changed. Now images are lazy loaded by default which speeds up page load on slow networks and/or big pages and also the print preview.</p>
|
|
<p>For that the JavaScript code to handle the <a href="../../cont/markdown/#further-image-formatting">lightbox and image effects</a> on the client side was removed in favour for static generation of those effects on the server.</p>
|
|
<p>If you have used HTML directly in your Markdown files, this now has the downside that it doesn’t respect the effect query parameter anymore. In this case you have to migrate all your HTML <code>img</code> URLs manually to the 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">With the proper settings</a> in your <code>config.toml</code> your page is now servable from the local file system using <code>file://</code> URLs.</p>
|
|
<p>Please note that the searchbox will only work for this if you reconfigure your outputformat for the homepage in your <code>config.toml</code> from <code>JSON</code> to <code>SEARCH</code>. The now deprecated <code>JSON</code> outputformat still works as before, so there is no need to reconfigure your installation if it is 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> The <a href="../../shortcodes/button/"><code>button</code> shortcode</a> has a new parameter <code>target</code> to set the destination frame/window for the URL to open. If not given, it defaults to a new window/tab for external URLs or is not set at all for internal URLs. Previously even internal URLs where opened in 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> The <a href="../../shortcodes/math/"><code>math</code> shortcode</a> and <a href="../../shortcodes/mermaid/"><code>mermaid</code> shortcode</a> now also support the <code>align</code> parameter if codefence syntax is 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 for languages that are written right to left (like Arabic). This is only implemented for the content area but not the navigation sidebar. This feature is not available in 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> Translation for 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 the effort to comply with WCAG standards, the implementation of the collapsible menu was changed. The functionality of the new implementation does not work with 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 formatting</a> has two new classes to align images to the <code>left</code> or <code>right</code>. Additionally, the already existing <code>inline</code> option is 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> Printing for the <a href="../../shortcodes/swagger/"><code>swagger</code> shortcode</a> was optimized to expand sections that are usually closed in interactive mode. This requires <a href="../../basics/configuration/#activate-print-support">print support</a> to 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> in your <code>config.toml</code>, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the 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 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 the print preview URLs were non deterministic for normal pages in comparison to page bundles, this is now changed. Each print preview is now accessible by adding a <code>index.print.html</code> to the default URL.</p>
|
|
<p>You can revert this behavior by overwriting the PRINT output format setting in your <code>config.toml</code>to:</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">permalinkable</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">Breaking</span></span> The theme changed how JavaScript and CSS dependencies are loaded to provide a better performance. In case you’ve added own JavaScript code that depends on the themes jQuery implementation, you have to put it into a separate <code>*.js</code> file (if not already) and add the <code>defer</code> keyword to the <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> The way <a href="../../cont/archetypes/">archetypes</a> are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones.</p>
|
|
<p>Your existing markdown files will still work like before and therefore you don’t need to change anything after the upgrade. Nevertheless, it is recommended to adapt your existing markdown files to the new way as follows:</p>
|
|
<ul>
|
|
<li>
|
|
<p>for your home page, add the frontmatter parameter <code>archetype = "home"</code> and remove the leading heading</p>
|
|
</li>
|
|
<li>
|
|
<p>for all files containing the deprecated frontmatter parameter <code>chapter = true</code>, replace it with <code>archetype = "chapter"</code> and remove the leading headings</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> The frontmatter options <code>pre</code> / <code>post</code> were renamed to <code>menuPre</code> / <code>menuPost</code>. The old options will still be used if the new options aren’t set. Therefore you don’t need to change anything after the 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> Adding new partials <code>heading-pre.html</code> / <code>heading-post.html</code> and according frontmatter options <code>headingPre</code> / <code>headingPost</code> to modify the way your page`s main heading 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> The new shortcode <code>math</code> is available to add beautiful math and chemical formulae. See the <a href="../../shortcodes/math/">documentation</a> for available features. This feature will not work with 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">Breaking</span></span> The second parameter for the <a href="../../shortcodes/include/"><code>include</code> shortcode</a> was switched in meaning and was renamed from <code>showfirstheading</code> to <code>hidefirstheading</code>. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.</p>
|
|
<p>If you’ve used the second boolean parameter, you have to rename it and invert its value to achieve the 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 the <a href="../../shortcodes/tabs/"><code>tabs</code> shortcode</a> could not find a tab item because, the tabs ended up empty. Now the first tab is 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> The <code>landingPageURL</code> was removed from <code>config.toml</code>. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page 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 shortcodes can now be also called from your partials. Examples for this are added to the documentation of 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 fixing issues with the search functionality for non Latin languages, you can now <a href="../../cont/i18n/#search-with-mixed-language-support">configure to have multiple languages on a single page</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">Breaking</span></span> The <code>custom_css</code> config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the <code>custom-header.html</code> template in 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">Breaking</span></span> Because anchor hover color was not configurable without introducing more complexity to the variant stylesheets, we decided to remove <code>--MAIN-ANCHOR-color</code> instead. You don’t need to change anything in your custom color stylesheet as the anchors now get their colors from <code>--MAIN-LINK-color</code> and <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 shortcodes now support named parameter. The positional parameter are still supported but will not be enhanced with new features, so you don’t need to change anything in your installation.</p>
|
|
<p>This applies to <a href="../../shortcodes/expand/"><code>expand</code></a>, <a href="../../shortcodes/include/"><code>include</code></a>, <a href="../../shortcodes/notice/"><code>notice</code></a> and <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> The <a href="../../shortcodes/button/"><code>button</code></a> shortcode received some love and now has a parameter for the color style similar to other shortcodes.</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> and <code>--SECONDARY-color</code> were added to provide easier modification of your custom style. Shortcodes with a color style can now have <code>primary</code> or <code>secondary</code> as additional values.</p>
|
|
<p>These two colors are the default for other, more specific color variables. You don’t need to change anything in your existing custom color stylesheets as those variables get reasonable 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> Translation for Polish. This language is not supported for 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> The documentation for all shortcodes 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">Breaking</span></span> If you had previously overwritten the <code>custom-footer.html</code> partial to add visual elements below the content of your page, you have to move this content to the new partial <code>content-footer.html</code>. <code>custom-footer.html</code> was never meant to contain HTML other than additional styles and 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 you prefer expandable/collapsible menu items, you can now set <code>collapsibleMenu=true</code> in your <code>config.toml</code>. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you 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> You can activate <a href="../../basics/configuration/#activate-print-support">print support</a> in your <code>config.toml</code> to add the capability to print whole chapters or even the complete site.</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> Translation for 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> Introduction of new CSS variables to set the font. The theme distinguishes between <code>--MAIN-font</code> for all content text and <code>--CODE-font</code> for inline or block code. There are additional overrides for all headings. See the <a href="../../basics/generator/">theme variant generator</a> of the exampleSite for all available 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> The new shortcode <code>swagger</code> is available to include a UI for REST OpenAPI Specifications. See the <a href="../../shortcodes/swagger/">documentation</a> for available features. This feature will not work with 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 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 the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Mermaid codefences. This changes the behavior of <code>disableMermaid</code> config option as follows: If a Mermaid shortcode or codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.</p>
|
|
<p>The option is still useful in case you are using scripting to set up your graph. In this case no shortcode or codefence is involved and the library is not loaded by default. In this case you can set <code>disableMermaid=false</code> in your frontmatter to force the library to be loaded. See the <a href="../../basics/generator/">theme variant generator</a> of the exampleSite for 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 variable <code>--MERMAID-theme</code> to set the variant’s Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the 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> and <a href="../../shortcodes/notice/"><code>notice</code></a> shortcodes have a new parameter to override the default icon. Allowed values are all <a href="https://fontawesome.com/v5/search?m=free" target="_blank">Font Awesome 5 Free</a> icons.</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">Breaking</span></span> We made changes to the menu footer. If you have your <code>menu-footer.html</code> <a href="../../basics/customization/">partial overridden</a>, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the <code>menu-footer.html</code> partial that is coming with the exampleSite.</p>
|
|
<p>This change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and <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">Breaking</span></span> We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation.</p>
|
|
<p>This change will only affect your installation if you’ve not set the <code>themeVariant</code> parameter in your <code>config.toml</code>. <a href="../../basics/customization/#theme-variant">If you still want to use the Learn color variant</a>, you have to explicitly set <code>themeVariant="learn"</code> in your <code>config.toml</code>.</p>
|
|
<p>Note, that this will also affect your site if viewed with Internet Explorer 11 but in 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 to a bug, that we couldn’t fix in a general manner for color variants, we decided to remove <code>--MENU-SEARCH-BOX-ICONS-color</code> and introduced <code>--MENU-SEARCH-color</code> instead. You don’t need to change anything in your custom color stylesheet as the 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> to <code>--MENU-SEARCH-BORDER-color</code>. You don’t need to change anything in your custom color stylesheet as the 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> With this release you are now capable to define your own <em>dark mode</em> variants.</p>
|
|
<p>To make this possible, we have introduced a lot more color variables you can use in <a href="../../basics/customization/#theme-variant">your color variants</a>. Your old variants will still work and don’t need to be changed as appropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.</p>
|
|
<p>To see what’s now possible, see the new variants <code>relearn-dark</code> and <code>neon</code> that are coming with 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> To make the creation of new variants easier for you, we’ve added a new interactive <a href="../../basics/generator/">theme variant generator</a>. This feature will not work with 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> You can now configure multiple color variants in your <code>config.toml</code>. In this case, the first variant is the default chosen on first view and a variant switch will be shown in the menu footer. See the <a href="../../basics/customization/#multiple-variants">documentation</a> for configuration.</p>
|
|
<p>Note, that the new variant switch will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant switcher will not be displayed with 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">Breaking</span></span> This release removes the themes implementation of <code>ref</code>/<code>relref</code> in favor for Hugos standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.</p>
|
|
<p>In a standard compliant form you must not link to the <code>*.md</code> file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the 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/configuration</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Leaf bundle</td>
|
|
<td><code>basics/configuration/index.md</code></td>
|
|
<td><code>basics/configuration</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Page</td>
|
|
<td><code>basics/configuration.md</code></td>
|
|
<td><code>basics/configuration</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version" target="_blank">Hugo got you covered</a> as well.</p>
|
|
<p>Also, the old themes implementation allowed refs to non-existing content. This will cause Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version" target="_blank">reconfigure the error handling</a> of Hugos implementation.</p>
|
|
<p>In the best case your usage of the old implementation is already standard compliant and you don’t need to change anything. You’ll notice this very easily once you’ve started <code>hugo server</code> after an upgrade and no errors are written to the console.</p>
|
|
<p>You may see errors on the console after the update in the 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>: page not found
|
|
</span></span></code></pre></div><p>In this case, you must apply one of two options:</p>
|
|
<ol>
|
|
<li>
|
|
<p>Copy the old implementation files <code>theme/hugo-theme-relearn/layouts/shortcode/ref.html</code> and <code>theme/hugo-theme-relearn/layouts/shortcode/relref.html</code> to your own projects <code>layouts/shortcode/ref.html</code> and <code>layouts/shortcode/relref.html</code> respectively. <strong>This is not recommended</strong> as your project will still rely on non-standard behavior afterwards.</p>
|
|
</li>
|
|
<li>
|
|
<p>Start up a text editor with regular expression support for search and replace. Apply the following conversions in the given order on all <code>*.md</code> files. <strong>This is the recommended choice</strong>.</p>
|
|
</li>
|
|
</ol>
|
|
<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>Page</td>
|
|
<td><code>(ref\s+"[^"]*)\.md"</code></td>
|
|
<td><code>$1"</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</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 the font <code>Novacento</code>/<code>Novecento</code>. If you use it in an overwritten CSS please replace it with <code>Work Sans</code>. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for 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> The theme now supports favicons served from <code>static/images/</code> named as <code>favicon</code> or <code>logo</code> in SVG, PNG or ICO format <a href="../../basics/customization/#change-the-favicon">out of the box</a>. An overridden partial <code>layouts/partials/favicon.html</code> may not be necessary anymore in 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> You can hide the table of contents menu for the whole site by setting the <code>disableToc</code> option in your <code>config.toml</code>. For an example see <a href="../../basics/configuration/#global-site-parameters">the example configuration</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 for <a href="../../shortcodes/notice/"><code>notice</code></a> shortcode to set title in 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> Your site can now be served from a subfolder if you set <code>baseURL</code> and <code>canonifyURLs=true</code> in your <code>config.toml</code>. See the <a href="../../basics/configuration/#a-word-on-running-your-site-in-a-subfolder">documentation</a> for 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> and <code>--CODE-BLOCK-BG-color</code> were added to provide a fallback for Hugos syntax highlighting in case <code>guessSyntax=true</code> is set. Ideally the colors are set to the same values as the ones from your 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> Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is 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 pages are displayed by default in their according tags page. You can now turn off this behavior by setting <code>disableTagHiddenPages=true</code> in your <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> You can define the expansion state of your menus for the whole site by setting the <code>alwaysopen</code> option in your <code>config.toml</code>. Please see further <a href="../../cont/pages/#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and 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> option to change immediate children sorting in menu and <code>children</code> shortcode. Possible values are <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 content of a page is now advertised in the HTML meta tags. See <a href="https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head" target="_blank">Hugo documentation</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 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 providing a documentation translation “fer us pirrrates”. There will be no other translations besides the original English one and the Pirates one due to 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 pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting <code>disableSeoHiddenPages=true</code> in your <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 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 the site’s structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see <code>CHANGELOG.md</code> in the exampleSite), they will now be ignored by the 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 pages are indexed for the site search by default. You can now turn off this behavior by setting <code>disableSearchHiddenPages=true</code> in your <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 is found in an <code>expand</code> shortcode, the 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> The menu will scroll the active item into view on load.</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> Syntax highlighting was switched to the <a href="https://gohugo.io/content-management/syntax-highlighting/" target="_blank">built in Hugo mechanism</a>. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation</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 the predefined stylesheets there was a typo and <code>--MENU-HOME-LINK-HOVERED-color</code> must be changed to <code>--MENU-HOME-LINK-HOVER-color</code>. You don’t need to change anything in your custom color stylesheet as the 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> and <code>--MENU-HOME-LINK-HOVER-color</code> were missing in the documentation. You should add them to your custom stylesheets if you want to override the 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 navigation and <code>children</code> shortcode were ignoring setting for <code>ordersectionsby</code>. This is now changed and may result in different sorting order of your sub pages.</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 pages are accessed directly by typing their URL, they will be exposed in the 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 page 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> You can define the expansion state of your menus in the frontmatter. Please see further <a href="../../cont/pages/#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and 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 for defining pre/post content for menu items and the content. See <a href="../../basics/customization/">documentation</a> for further reading.</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> with 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> to include arbitrary file content into a page.</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> with new parameter to open on page load.</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">Breaking</span></span> <a href="../../shortcodes/mermaid/">Mermaid</a> diagrams can now be panned and zoomed. This isn’t configurable 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>Mermaid</code></a> config options can be set in <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> The requirement for the Hugo version of this theme is the same as for the Learn 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 of the <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learn theme</a> based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to <code>Relearn</code> and a new logo. For the reasons behind forking the Learn theme, see <a href="https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495" target="_blank">this comment</a> in the Learn issues.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="../../js/clipboard.min.js?1676046695" defer></script>
|
|
<script src="../../js/perfect-scrollbar.min.js?1676046695" defer></script>
|
|
<script src="../../js/theme.js?1676046695" defer></script>
|
|
</body>
|
|
</html>
|