<p>This document shows you what’s new in the latest release. For a detailed list of changes, see the <ahref="../basics/history/">history page</a>.</p>
<p><strong>Change</strong>: 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>
<p><strong>New</strong>: The <ahref="../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>
<p><strong>New</strong>: 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 <ahref="../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><strong>New</strong>: 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><strong>New</strong>: 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 <ahref="../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><strong>New</strong>: 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>
<p><strong>Change</strong>: 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 <ahref="../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>
<p><strong>Change</strong>: <ahref="../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>
<p><strong>Change</strong>: The <ahref="../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>
<p><strong>New</strong>: The <ahref="../shortcodes/math/"><code>math</code> shortcode</a> and <ahref="../shortcodes/mermaid/"><code>mermaid</code> shortcode</a> now also support the <code>align</code> parameter if codefence syntax is used.</p>
<p><strong>New</strong>: 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>
<p><strong>Change</strong>: In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed. Although the functionality of the new implementation works with old browsers (Internet Explorer 11), the display of the expander icons does not and is limited to modern browsers.</p>
<p><strong>New</strong>: <ahref="../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>
<p><strong>New</strong>: Printing for the <ahref="../shortcodes/swagger/"><code>swagger</code> shortcode</a> was optimized to expand sections that are usually closed in interactive mode. This requires <ahref="../basics/configuration/#activate-print-support">print support</a> to be configured.</p>
<li><strong>Change</strong>: 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>
<p><strong>Change</strong>: 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>
<p><strong>Breaking</strong>: 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>
<p><strong>Change</strong>: The way <ahref="../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>
<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><strong>Change</strong>: 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>
<p><strong>New</strong>: 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>
<p><strong>New</strong>: The new shortcode <code>math</code> is available to add beautiful math and chemical formulae. See the <ahref="../shortcodes/math/">documentation</a> for available features. This feature will not work with Internet Explorer 11.</p>
<p><strong>Breaking</strong>: The second parameter for the <ahref="../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><strong>Change</strong>: Previously, if the <ahref="../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>
<p><strong>Change</strong>: 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>
<p><strong>New</strong>: All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.</p>
<li><strong>New</strong>: While fixing issues with the search functionality for non Latin languages, you can now <ahref="../cont/i18n/#search-with-mixed-language-support">configure to have multiple languages on a single page</a>.</li>
<p><strong>Breaking</strong>: 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>
<p><strong>Breaking</strong>: 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>
<p><strong>New</strong>: 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 <ahref="../shortcodes/expand/"><code>expand</code></a>, <ahref="../shortcodes/include/"><code>include</code></a>, <ahref="../shortcodes/notice/"><code>notice</code></a> and <ahref="../shortcodes/siteparam/"><code>siteparam</code></a>.</p>
<p><strong>New</strong>: The <ahref="../shortcodes/button/"><code>button</code></a> shortcode received some love and now has a parameter for the color style similar to other shortcodes.</p>
<p><strong>New</strong>: 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>
<p><strong>Breaking</strong>: 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>
<p><strong>New</strong>: 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>
<p><strong>New</strong>: You can activate <ahref="../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>
<p><strong>New</strong>: 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 <ahref="../basics/generator/">theme variant generator</a> of the exampleSite for all available variables.</p>
<p><strong>New</strong>: The new shortcode <code>swagger</code> is available to include a UI for REST OpenAPI Specifications. See the <ahref="../shortcodes/swagger/">documentation</a> for available features. This feature will not work with Internet Explorer 11.</p>
<p><strong>Change</strong>: 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 <ahref="../basics/generator/">theme variant generator</a> of the exampleSite for an example.</p>
<p><strong>This change requires at least Hugo 0.93.0 to be used</strong>. The minimum requirement will be reported during build on the console if not met.</p>
</li>
<li>
<p><strong>New</strong>: 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><strong>New</strong>: <ahref="../shortcodes/attachments/"><code>attachment</code></a> and <ahref="../shortcodes/notice/"><code>notice</code></a> shortcodes have a new parameter to override the default icon. Allowed values are all <ahref="https://fontawesome.com/v5/search?m=free">Font Awesome 5 Free</a> icons.</li>
<p><strong>Breaking</strong>: We made changes to the menu footer. If you have your <code>menu-footer.html</code><ahref="../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><strong>Breaking</strong>: 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>. <ahref="../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>
<p><strong>Change</strong>: 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>
<p><strong>Change</strong>: 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><strong>New</strong>: 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 <ahref="../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><strong>New</strong>: To make the creation of new variants easier for you, we’ve added a new interactive <ahref="../basics/generator/">theme variant generator</a>. This feature will not work with Internet Explorer 11.</p>
<p><strong>New</strong>: 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 <ahref="../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>
<p><strong>Breaking</strong>: 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>
<p>If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but <ahref="https://gohugo.io/content-management/cross-references/#link-to-another-language-version">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 <ahref="https://gohugo.io/content-management/cross-references/#link-to-another-language-version">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>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-sh"data-lang="sh"><spanclass="line"><spanclass="cl">ERROR 2021/11/19 22:29:10 <spanclass="o">[</span>en<spanclass="o">]</span> REF_NOT_FOUND: Ref <spanclass="s2">"basics/configuration/_index.md"</span>: <spanclass="s2">"hugo-theme-relearn\exampleSite\content\_index.en.md:19:22"</span>: 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>
<p><strong>Change</strong>: 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>
<p><strong>New</strong>: 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 <ahref="../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>
<p><strong>New</strong>: 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 <ahref="../basics/configuration/#global-site-parameters">the example configuration</a>.</p>
<li><strong>New</strong>: Optional second parameter for <ahref="../shortcodes/notice/"><code>notice</code></a> shortcode to set title in box header.</li>
<li><strong>New</strong>: 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 <ahref="../basics/configuration/#a-word-on-running-your-site-in-a-subfolder">documentation</a> for a detailed example.</li>
<li><strong>Change</strong>: 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>
<p><strong>Change</strong>: 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><strong>New</strong>: 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>
<p><strong>New</strong>: 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 <ahref="../cont/pages/#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and default behavior.</p>
<p><strong>New</strong>: 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><strong>New</strong>: Alternate content of a page is now advertised in the HTML meta tags. See <ahref="https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head">Hugo documentation</a>.</p>
<li><strong>New</strong>: 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.</li>
<li><strong>New</strong>: 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>
<p><strong>Change</strong>: 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>
<p><strong>New</strong>: 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><strong>New</strong>: If a search term is found in an <code>expand</code> shortcode, the expand will be opened.</p>
</li>
<li>
<p><strong>New</strong>: The menu will scroll the active item into view on load.</p>
<p><strong>Change</strong>: Syntax highlighting was switched to the <ahref="https://gohugo.io/content-management/syntax-highlighting/">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>
<p><strong>Change</strong>: 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><strong>Change</strong>: <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><strong>Change</strong>: 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><strong>Change</strong>: If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.</p>
</li>
<li>
<p><strong>Change</strong>: A page without a <code>title</code> will be treated as <code>hidden=true</code>.</p>
<p><strong>New</strong>: You can define the expansion state of your menus in the frontmatter. Please see further <ahref="../cont/pages/#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and default behavior.</p>
<p><strong>New</strong>: New partials for defining pre/post content for menu items and the content. See <ahref="../basics/customization/">documentation</a> for further reading.</p>
<li><strong>New</strong>: <ahref="../shortcodes/mermaid/#configuration"><code>Mermaid</code></a> config options can be set in <code>config.toml</code>.</li>
<li><strong>New</strong>: Initial fork of the <ahref="https://github.com/matcornic/hugo-theme-learn">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 <ahref="https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495">this comment</a> in the Learn issues.</li>
<p>Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.</p>
<p>Just download latest version of <ahref="https://gohugo.io/getting-started/installing/">Hugo binary</a> for your OS (Windows, Linux, Mac) : it’s that simple.</p>
<p>The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this <ahref="https://gohugo.io/overview/quickstart/">great documentation for beginners</a>.</p>
<h2id="create-your-project">Create your project</h2>
<p>Hugo provides a <code>new</code> command to create a new website.</p>
<pretabindex="0"><code>hugo new site <new_project>
</code></pre><h2id="install-the-theme">Install the theme</h2>
<p>Install the Relearn theme by following <ahref="https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme">this documentation</a></p>
<p>This theme’s repository is: <ahref="https://github.com/McShelby/hugo-theme-relearn.git">https://github.com/McShelby/hugo-theme-relearn.git</a></p>
<p>Alternatively, you can <ahref="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip">download the theme as .zip</a> file and extract it in the <code>themes</code> directory</p>
<p>When building the website, you can set a theme by using <code>--theme</code> option. However, we suggest you modify the configuration file (<code>config.toml</code>) and set the theme as the default. You can also add the <code>[outputs]</code> section to enable the search functionality.</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="c"># Change the default theme to be use when building the site with Hugo</span>
</span></span></code></pre></div><h2id="create-your-first-chapter-page">Create your first chapter page</h2>
<p>Chapters are pages that contain other child pages. It has a special layout style and usually just contains a <em>chapter name</em>, the <em>title</em> and a <em>brief abstract</em> of the section.</p>
<p>The Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind chapter basics/_index.md
</span></span></code></pre></div><p>By opening the given file, you should see the property <code>chapter=true</code> on top, meaning this page is a <em>chapter</em>.</p>
<p>By default all chapters and pages are created as a draft. If you want to render these pages, remove the property <code>draft: true</code> from the metadata.</p>
<h2id="create-your-first-content-pages">Create your first content pages</h2>
<p>Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:</p>
<divclass="highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new basics/first-content.md
</span></span><spanclass="line"><spanclass="cl">hugo new basics/second-content/_index.md
</span></span></code></pre></div><p>Feel free to edit those files by adding some sample content and replacing the <code>title</code> value in the beginning of the files.</p>
<h2id="launching-the-website-locally">Launching the website locally</h2>
</span></span></code></pre></div><p>Go to <code>http://localhost:1313</code></p>
<p>You should notice three things:</p>
<ol>
<li>You have a left-side <strong>Basics</strong> menu, containing two submenus with names equal to the <code>title</code> properties in the previously created files.</li>
<li>The home page explains how to customize it by following the instructions.</li>
<li>When you run <code>hugo serve</code>, when the contents of the files change, the page automatically refreshes with the changes. Neat!</li>
</ol>
<h2id="build-the-website">Build the website</h2>
<p>When your site is ready to deploy, run the following command:</p>
</span></span></code></pre></div><p>A <code>public</code> folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.</p>
<p>This website can be automatically published and hosted with <ahref="https://www.netlify.com/">Netlify</a> (Read more about <ahref="https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/">Automated HUGO deployments with Netlify</a>). Alternatively, you can use <ahref="https://gohugo.io/hosting-and-deployment/hosting-on-github/">GitHub pages</a></p>
<h2id="global-site-parameters">Global site parameters</h2>
<p>On top of <ahref="https://gohugo.io/overview/configuration/">Hugo global configuration</a>, the Relearn theme lets you define the following parameters in your <code>config.toml</code> (here, values are default).</p>
<p>Note that some of these parameters are explained in details in other sections of this documentation.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># This controls whether submenus will be expanded (true), or collapsed (false) in the</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># menu; if no setting is given, the first menu level is set to false, all others to true;</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># this can be overridden in the pages frontmatter</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Prefix URL to edit current page. Will display an "Edit" button on top right hand corner of every page.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Useful to give opportunity to people to create merge request for your doc.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># See the config.toml file from this documentation site to have an example.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Javascript and CSS cache are automatically busted when new version of site is generated.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Set this to true to disable this behavior (some proxies don't handle well this optimization)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Set this to true if you want to disable generation for generator version meta tags of hugo and the theme;</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># don't forget to also set Hugo's disableHugoGeneratorInject=true, otherwise it will generate a meta tag into your home page</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># A title for shortcuts in menu is set by default. Set this to true to disable it.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set to false, a Home button will appear below the search bar on the menu.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># It is redirecting to the landing page of the current language if specified. (Default is "/")</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set to false, load the MathJax module on every page regardless if a MathJax shortcode is present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set to false, load the Mermaid module on every page regardless if a Mermaid shortcode or Mermaid codefence is present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set to false, load the Swagger module on every page regardless if a Swagger shortcode is present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Hide Next and Previous page buttons normally displayed full height beside content</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Order sections in menu by "weight" or "title". Default to "weight";</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># this can be overridden in the pages frontmatter</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Change default color scheme with a variant one. Eg. can be "red", "blue", "green" or an array like [ "blue", "green" ].</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set to true, the menu in the sidebar will be displayed in a collapsible tree view. Although the functionality works with old browsers (IE11), the display of the expander icons is limited to modern browsers</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set to true, no index.html will be appended to prettyURLs; this will cause pages not</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># to be servable from the file system</span>
<p>If your site is served from a subfolder, eg. <code>https://example.com/mysite/</code>, you have to set the following lines to your <code>config.toml</code></p>
</span></span></code></pre></div><p>Without <code>canonifyURLs=true</code> URLs in sublemental pages (like <code>sitemap.xml</code>, <code>rss.xml</code>) will be generated falsly while your HTML files will still work. See <ahref="https://github.com/gohugoio/hugo/issues/5226">https://github.com/gohugoio/hugo/issues/5226</a>.</p>
<h2id="serving-your-page-from-the-filesystem">Serving your page from the filesystem</h2>
<p>If you want your page served from the filesystem by using URLs starting with <code>file://</code> you’ll need the following configuration in your <code>config.toml</code>:</p>
</span></span></code></pre></div><p>The theme will append an additional <code>index.html</code> to all branch bundle links by default to make the page be servable from the file system. If you don’t care about the file system and only serve your page via a webserver you can also generate the links without this change by adding this to your <code>config.toml</code></p>
<p>If you want to use the search feature from the file system using an older installation of the theme make sure to change your outputformat for the homepage from the now deprecated <code>JSON</code> to <code>SEARCH</code><ahref="#activate-search">as seen below</a>.</p>
</span></span></code></pre></div><p>This will generate a search index file at the root of your public folder ready to be consumed by the lunr.js javascript search engine. Note that the <code>SEARCH</code> outputformat was named <code>JSON</code> in previous releases but was implemented differently. Although <code>JSON</code> still works, it is now deprecated.</p>
<p>You can add a dedicated search page for your page by adding the <code>SEARCHPAGE</code> outputformat to your home page by adding the following lines in your <code>config.toml</code> file.</p>
</span></span></code></pre></div><p>You can access this page by either clicking on the magnifier glass or by typing some search term and pressing <code>ENTER</code> inside of the menu’s search box .</p>
<imgsrc="../basics/configuration/search_page.png?&width=60pc"alt="Screenshot of the dedicated search page"style="height: auto; width: 60pc;"loading="lazy">
<p>You can activate print support to add the capability to print whole chapters or even the complete site. Just add the <code>PRINT</code> output format to your home, section and page in your <code>config.toml</code> as seen below:</p>
</span></span></code></pre></div><p>This will add a little printer icon in the top bar. It will switch the page to print preview when clicked. You can then send this page to the printer by using your browser’s usual print functionality.</p>
<p>The resulting URL will not be <ahref="https://gohugo.io/templates/output-formats/#configure-output-formats">configured ugly</a> in terms of <ahref="https://gohugo.io/content-management/urls/#ugly-urls">Hugo’s URL handling</a> even if you’ve set <code>uglyURLs=true</code> in your <code>config.toml</code>. This is due to the fact that for one mime type only one suffix can be configured.</p>
<p>Nevertheless, if you’re unhappy with the resulting URLs you can manually redefine <code>outputFormats.PRINT</code> in your own <code>config.toml</code> to your liking.</p>
<p>The MathJax configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See <ahref="../shortcodes/math/">Math</a> for additional documentation.</p>
<p>MathJax is globally disabled. By default it won’t be loaded by any page.</p>
<p>On page “Physics” you coded some JavaScript for a dynamic formulae. You can set the MathJax parameters locally to load mathJax on this page.</p>
<p>You also can disable MathJax for specific pages while globally enabled.</p>
<p>The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See <ahref="../shortcodes/mermaid/">Mermaid</a> for additional documentation.</p>
<p>Mermaid is globally disabled. By default it won’t be loaded by any page.</p>
<p>On page “Architecture” you coded some JavaScript to dynamically generate a class diagram. You can set the Mermaid parameters locally to load mermaid on this page.</p>
<p>The Relearn theme has been built to be as configurable as possible by defining multiple <ahref="https://gohugo.io/templates/partials/">partials</a></p>
<p>In <code>themes/hugo-theme-relearn/layouts/partials/</code>, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead <ahref="https://gohugo.io/themes/customizing/">follow this page</a>. You’d create a new partial in the <code>layouts/partials</code> folder of your local project. This partial will have the priority.</p>
<p>This theme defines the following partials :</p>
<li><code>header.html</code>: the header of the page. See <ahref="#output-formats">output-formats</a></li>
<li><code>footer.html</code>: the footer of the page. See <ahref="#output-formats">output-formats</a></li>
<li><code>body.html</code>: the body of the page. The body may contain of one or many articles. See <ahref="#output-formats">output-formats</a></li>
<li><code>article.html</code>: the output for a single article, can contain elements around your content. See <ahref="#output-formats">output-formats</a></li>
<li><code>menu.html</code>: left menu. <em>Not meant to be overwritten</em></li>
<li><code>search.html</code>: search box. <em>Not meant to be overwritten</em></li>
<li><code>custom-header.html</code>: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include <code>style</code> HTML tag directive in your file.</li>
<li><code>custom-footer.html</code>: custom footer in page. Meant to be overwritten when adding JavaScript. Don’t forget to include <code>javascript</code> HTML tag directive in your file.</li>
<li><code>heading-pre.html</code>: side-wide configuration to prepend to pages title headings. If you override this, it is your responsibility to take the page’s <code>headingPre</code> setting into account.</li>
<li><code>heading-post.html</code>: side-wide configuration to append to pages title headings. If you override this, it is your responsibility to take the page’s <code>headingPost</code> setting into account.</li>
<li><code>menu-pre.html</code>: side-wide configuration to prepend to menu items. If you override this, it is your responsibility to take the page’s <code>menuPre</code> setting into account.</li>
<li><code>menu-post.html</code>: side-wide configuration to append to menu items. If you override this, it is your responsibility to take the page’s <code>menuPost</code> setting into account.</li>
<li><code>content.html</code>: the content page itself. This can be overridden if you want to display page’s meta data above or below the content.</li>
<p>If your favicon is a SVG, PNG or ICO, just drop off your image in your local <code>static/images/</code> folder and name it <code>favicon.svg</code>, <code>favicon.png</code> or <code>favicon.ico</code> respectively.</p>
<p>If no favicon file is found, the theme will lookup the alternative filename <code>logo</code> in the same location and will repeat the search for the list of supported file types.</p>
<p>If you need to change this default behavior, create a new file in <code>layouts/partials/</code> named <code>favicon.html</code>. Then write something like this:</p>
<p>You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant switch will be shown in the menu footer.</p>
<p>If you want to switch the syntax highlighting theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation <ahref="https://gohugo.io/content-management/syntax-highlighting/">according to Hugo’s documentation</a>, and <code>@import</code> this stylesheet in your color variant stylesheet. For an example, take a look into <code>theme-relearn-light.css</code> and <code>config.toml</code> of the exampleSite.</p>
<p>If you are not happy with the shipped variants you can either copy and rename one of the shipped files from <code>themes/hugo-theme-relearn/static/css</code> to <code>static/css</code>, edit them afterwards to your liking in a text editor and configure the <code>themeVariant</code> parameter in your <code>config.toml</code> or just use the <ahref="../basics/generator/">interactive variant generator</a>.</p>
<p>Certain parts of the theme can be changed for support of your own <ahref="https://gohugo.io/templates/output-formats/">output formats</a>. Eg. if you define a new output format <code>PLAINTEXT</code> in your <code>config.toml</code>, you can add a file <code>layouts/partials/header.plaintext.html</code> to change the way, the page header should look like for that output format.</p>
<p>This interactive tool may help you to generate your own color variant stylesheet.</p>
<p>To get started, first select a color variant from the variant switch that fits you best as a starting point.</p>
<p>The graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph and the page will update accordingly.</p>
<p>The arrowed lines reflects how colors are inherited thru different parts of the theme if the descendent isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.</p>
<p>To better understand this select the <code>neon</code> variant and modify the different heading colors. There, colors for the heading <code>h2</code>, <code>h3</code> and <code>h4</code> are explicitly set. <code>h5</code> is not set and inherits its value from <code>h4</code>. <code>h6</code> is also not set and inherits its value from <code>h5</code>.</p>
<p>Once you’ve changed a color, the variant switch will show a “My custom variant” entry and your changes are stored in the browser. You can change pages and even close the browser without losing your changes.</p>
<p>Once you are satisfied, you can download the new variants file and copy it into your site’s <code>static/css</code> directory. Afterwards you have to adjust the <code>themeVariant</code> parameter in your <code>config.toml</code> to your chosen file name.</p>
<p>Eg. if your new variants file is named <code>theme-my-custom-variant.css</code>, you have to set <code>themeVariant='my-custom-variant'</code> to use it.</p>
<li>[<strong>bug</strong>] search: don’t freeze browser on long search terms <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/408">#408</a></li>
<li>[<strong>bug</strong>] search: fix searchbox placeholder color in FF and IE <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/405">#405</a></li>
<li>[<strong>bug</strong>][<strong>change</strong>] i18n: rename Korean translation from country to lang code <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/404">#404</a></li>
</ul>
<h3id="maintenance">Maintenance</h3>
<ul>
<li>[<strong>task</strong>] search: update lunr languages to 1.10.0 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/403">#403</a></li>
</ul>
<hr>
<h2id="566-2022-11-23">5.6.6 (2022-11-23)</h2>
<h3id="enhancements-1">Enhancements</h3>
<ul>
<li>[<strong>feature</strong>] search: make build and js forgiving against config errors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/400">#400</a></li>
<li>[<strong>bug</strong>] theme: make alias pages usable by file:// protocol <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/398">#398</a></li>
<li>[<strong>bug</strong>] theme: be compatible with Hugo >= 0.95.0 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/397">#397</a></li>
<li>[<strong>feature</strong>] theme: make creation of generator meta tag configurable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/383">#383</a></li>
<li>[<strong>bug</strong>] mermaid: avoid leading whitespace <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/394">#394</a></li>
<li>[<strong>bug</strong>] theme: fix build errors when referencing SVGs in markdown <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/393">#393</a></li>
<li>[<strong>bug</strong>] variant: avoid neon to leak into IE11 fallback <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/392">#392</a></li>
<li>[<strong>bug</strong>] theme: fix urls for file:// protocol in sitemap <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/385">#385</a></li>
<li>[<strong>bug</strong>] theme: add id to h1 elements <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/384">#384</a></li>
<li>[<strong>bug</strong>] rss: fix display of hidden subpages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/382">#382</a></li>
<li>[<strong>bug</strong>] nav: fix key navigation when pressing wrong modifiers <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/379">#379</a></li>
<li>[<strong>bug</strong>] theme: fix typo in 404.html <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/376">#376</a></li>
<li>[<strong>bug</strong>] theme: allow menu items and children to be served by file:// protocol <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/375">#375</a></li>
<li>[<strong>bug</strong>] theme: fix overflowing issue with anchors and tooltips <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/364">#364</a></li>
<li>[<strong>bug</strong>] theme: fix multilang links when site served from subdirectory <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/370">#370</a></li>
<li>[<strong>feature</strong>] math: allow passing of parameters with codefence syntax <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/363">#363</a></li>
<li>[<strong>feature</strong>] mermaid: allow passing of parameters with codefence syntax <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/360">#360</a></li>
<li>[<strong>feature</strong>] i18n: support RTL <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/357">#357</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] button: add option for target <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/351">#351</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: allow to be served by file:// protocol <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/349">#349</a></li>
<li>[<strong>feature</strong>] expander: improve whitespace between label and content <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/338">#338</a></li>
<li>[<strong>feature</strong>] swagger: improve print version <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/333">#333</a></li>
<li>[<strong>task</strong>] task: bump Hugo minimum requirement to 0.95 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/319">#319</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] menu: expand collapsed menus if search term is found in submenus <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/312">#312</a></li>
<li>[<strong>bug</strong>] print: switch mermaid and swagger style before print <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/316">#316</a></li>
<li>[<strong>bug</strong>] theme: fix chapter margins on big screens <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/315">#315</a></li>
<li>[<strong>bug</strong>] tags: don’t count tags if page is hidden <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/310">#310</a></li>
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: optimize loading of js and css <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/303">#303</a></li>
<li>[<strong>feature</strong>] history: don’t reload page when history gets cleared <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/299">#299</a></li>
<li>[<strong>feature</strong>] menu: replace expander by fontawesome chevrons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/296">#296</a></li>
<li>[<strong>feature</strong>] theme: align content with topbar icon limits <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/290">#290</a></li>
<li>[<strong>feature</strong>] button: allow for empty href <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/288">#288</a></li>
<li>[<strong>feature</strong>] i18n: make Simplified Chinese the standard language for the <code>zn</code> code <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/287">#287</a></li>
<li>[<strong>feature</strong>] clipboard: move head styles to stylesheet <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/286">#286</a></li>
<li>[<strong>bug</strong>] favicon: fix URL if site resides in subfolder <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/302">#302</a></li>
<li>[<strong>bug</strong>] code: show copy-to-clipboard marker for blocklevel code <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/298">#298</a></li>
<li>[<strong>bug</strong>] menu: make active expander visible on hover <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/297">#297</a></li>
<li>[<strong>bug</strong>] print: add missing page break after index or section <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/292">#292</a></li>
<li>[<strong>bug</strong>] theme: use more space on wide screens <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/291">#291</a></li>
<li>[<strong>bug</strong>] theme: fix size of chapter heading <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/289">#289</a></li>
<li>[<strong>bug</strong>] swagger: javascript code does not load in documentation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/285">#285</a></li>
<li>[<strong>bug</strong>] children: descriptions not working <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/284">#284</a></li>
<li>[<strong>bug</strong>] print: fix empty page for shortcut links <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/283">#283</a></li>
<li>[<strong>bug</strong>][<strong>breaking</strong>] include: second parameter is ignored <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/281">#281</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] tabs: don’t change tab selection if panel does not contain item <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/279">#279</a></li>
<li>[<strong>feature</strong>] shortcodes: convert to partials <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/277">#277</a></li>
<li>[<strong>bug</strong>] notice: fix layout when content starts with heading <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/275">#275</a></li>
<li>[<strong>bug</strong>] i18n: Vietnamese language with wrong lang code <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/270">#270</a></li>
<li>[<strong>bug</strong>] swagger: adjust font-size for method buttons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/267">#267</a></li>
<li>[<strong>bug</strong>] menu: hide expander when only hidden subpages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/264">#264</a></li>
<li>[<strong>bug</strong>] theme: make compatible with Hugo 0.100.0 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/263">#263</a></li>
<li>[<strong>feature</strong>] shortcodes: add named parameter if missing <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/260">#260</a></li>
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: remove –MAIN-ANCHOR-color from stylesheet <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/256">#256</a></li>
<li>[<strong>feature</strong>] theme: use proper file extension for page-meta.go <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/246">#246</a></li>
<li>[<strong>feature</strong>] variant: add support for brand color variables <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/239">#239</a></li>
<li>[<strong>bug</strong>] shortcodes: accept boolean parameters if given as string <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/261">#261</a></li>
<li>[<strong>bug</strong>] print: adjust button and tab size <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/259">#259</a></li>
<li>[<strong>bug</strong>] print: show Mermaid if requested in frontmatter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/255">#255</a></li>
<li>[<strong>bug</strong>] theme: fix display of tooltip for heading anchor <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/241">#241</a></li>
<li>[<strong>feature</strong>] i18n: add Traditional Chinese translation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/233">#233</a></li>
<li>[<strong>feature</strong>] menu: expand/collapse menu items without navigation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/231">#231</a></li>
<li>[<strong>feature</strong>] theme: add CSS font variables <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/227">#227</a></li>
<li>[<strong>feature</strong>] swagger: add support for oas/swagger documentation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/226">#226</a></li>
<li>[<strong>bug</strong>] variant: make variant switch work on slow networks <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/228">#228</a></li>
<li>[<strong>bug</strong>] print: fix minor inconsistencies <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/225">#225</a></li>
<li>[<strong>bug</strong>] print: show more than just the title page <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/224">#224</a></li>
<li>[<strong>bug</strong>] theme: align content scrollbar to the right on big screens <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/223">#223</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] mermaid: support differing themes for color variant switch <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/219">#219</a></li>
<li>[<strong>bug</strong>] theme: make storage of multiple Hugo sites on same server distinct <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/214">#214</a></li>
<li>[<strong>bug</strong>] variant: switch breadcrumb color in Chrome <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/213">#213</a></li>
<li>[<strong>bug</strong>] mobile: improve behavior of sidebar menu <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/210">#210</a></li>
<li>[<strong>bug</strong>] variant: fix occasional fail when resetting generator <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/208">#208</a></li>
<li>[<strong>bug</strong>] docs: don’t move header on logo hover in IE11 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/207">#207</a></li>
<li>[<strong>bug</strong>] variant: avoid flash of menu header when non default variant is active <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/206">#206</a></li>
<li>[<strong>bug</strong>] theme: fix wrong HTML closing tag order in chapters <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/205">#205</a></li>
<li>[<strong>bug</strong>] theme: adjust breadcrumb and title for empty home page titles <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/202">#202</a></li>
<li>[<strong>bug</strong>] theme: remove Hugo build warning if page is not file based <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/197">#197</a></li>
<li>[<strong>bug</strong>] tags: adhere to titleSeparator <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/196">#196</a></li>
<li>[<strong>bug</strong>] theme: hide footer divider and variant selector in IE11 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/194">#194</a></li>
<li>[<strong>feature</strong>] children: set containerstyle automatically according to style <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/192">#192</a></li>
<li>[<strong>bug</strong>] theme: revert fontawsome to version 5 for IE11 compat <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/191">#191</a></li>
<li>[<strong>feature</strong>] variant: build a variant generator <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/188">#188</a></li>
<li>[<strong>feature</strong>] nav: only show toc if the page has headings <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/182">#182</a></li>
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: change default colors to Relearn defaults <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/181">#181</a></li>
<li>[<strong>feature</strong>] variant: add a variant selector <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/178">#178</a></li>
<li>[<strong>bug</strong>] search: remove additional X in filled out search box in IE11 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/190">#190</a></li>
<li>[<strong>bug</strong>][<strong>change</strong>] search: fix color change for icons on hover <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/176">#176</a></li>
<li>[<strong>bug</strong>] exampleSite: fix links in official documentation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/168">#168</a></li>
<li>[<strong>bug</strong>] menu: invalid URL when the shortcut is an internal link <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/163">#163</a></li>
<li>[<strong>bug</strong>] theme: fix selection of *.ico files as favicons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/160">#160</a></li>
<li>[<strong>bug</strong>] menu: fix significantly low performance for collecting of meta info <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/157">#157</a></li>
<li>[<strong>bug</strong>] search: make dropdown stick to search field when scrolling <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/155">#155</a></li>
<li>[<strong>bug</strong>] menu: align long text properly <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/154">#154</a></li>
<li>[<strong>bug</strong>] copyToClipBoard: add missing right border for inline code if <code>disableInlineCopyToClipBoard=true</code><ahref="https://github.com/McShelby/hugo-theme-relearn/issues/153">#153</a></li>
<li>[<strong>bug</strong>] menu: show hidden sibling pages reliably <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/152">#152</a></li>
<li>[<strong>bug</strong>] menu: bring active item in sight for large menus <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/149">#149</a></li>
<li>[<strong>bug</strong>] mermaid: always load javascript to avoid break if code fences are used <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/142">#142</a></li>
<li>[<strong>bug</strong>] search: don’t break JS in multilang setup if search is disabled <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/140">#140</a></li>
<li>[<strong>feature</strong>] toc: make disableTOC globally available via config.toml <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/133">#133</a></li>
<li>[<strong>feature</strong>] mermaid: only load javascript if necessary <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/95">#95</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: switch font <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/83">#83</a></li>
<li>[<strong>feature</strong>] theme: make favicon configurable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/2">#2</a></li>
<li>[<strong>bug</strong>] mermaid: assert that window.mermaid is actually mermaid <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/136">#136</a></li>
<li>[<strong>bug</strong>] menu: remove usage of Hugos UniqueID <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/131">#131</a></li>
<li>[<strong>bug</strong>] theme: reduce margin for children shortcode <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/130">#130</a></li>
<li>[<strong>bug</strong>] theme: left-align h3 in chapters <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/129">#129</a></li>
<li>[<strong>bug</strong>] theme: align copy link to clipboard <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/128">#128</a></li>
<li>[<strong>bug</strong>] theme: generate correct links if theme served from subdirectory <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/120">#120</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] syntax highlight: provide default colors for unknown languages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/113">#113</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: simplify stylesheet for color variants <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/107">#107</a></li>
<li>[<strong>feature</strong>] theme: announce alternative content in header <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/101">#101</a></li>
<li>[<strong>feature</strong>] menu: frontmatter option to change sort predicate <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/98">#98</a></li>
<li>[<strong>feature</strong>] menu: add default setting for menu expansion <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/97">#97</a></li>
<li>[<strong>bug</strong>] include: don’t generate additional HTML if file should be displayed “as is”<ahref="https://github.com/McShelby/hugo-theme-relearn/issues/110">#110</a></li>
<li>[<strong>bug</strong>] attachments: fix broken links if multilang config is used <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/105">#105</a></li>
<li>[<strong>bug</strong>] theme: fix sticky header to remove horizontal scrollbar <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/82">#82</a></li>
<li>[<strong>bug</strong>] docs: rename english pirate translation to avoid crash on rendering <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/90">#90</a></li>
<li>[<strong>feature</strong>] sitemap: hide hidden pages from sitemap and SEO indexing <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/85">#85</a></li>
<li>[<strong>bug</strong>] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/86">#86</a></li>
<li>[<strong>task</strong>] theme: switch from data-vocabulary to schema <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/84">#84</a></li>
<li>[<strong>feature</strong>] search: open expand if it contains search term <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/80">#80</a></li>
<li>[<strong>feature</strong>] menu: scroll active item into view <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/79">#79</a></li>
<li>[<strong>feature</strong>] search: disable search in hidden pages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/76">#76</a></li>
<li>[<strong>feature</strong>] search: improve readablility of index.json <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/75">#75</a></li>
<li>[<strong>feature</strong>] menu: show hidden pages if accessed directly <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/60">#60</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: treat pages without title as hidden <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/59">#59</a></li>
<li>[<strong>feature</strong>] search: show search results if field gains focus <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/58">#58</a></li>
<li>[<strong>feature</strong>] theme: add partial templates for pre/post menu entries <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/56">#56</a></li>
<li>[<strong>feature</strong>] theme: make chapter archetype more readable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/55">#55</a></li>
<li>[<strong>feature</strong>] children: add parameter for container style <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/53">#53</a></li>
<li>[<strong>feature</strong>] theme: make content a template <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/50">#50</a></li>
<li>[<strong>feature</strong>] menu: control menu expansion with alwaysopen parameter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/49">#49</a></li>
<li>[<strong>feature</strong>] include: new shortcode to include other files <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/43">#43</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] code highlighter: switch to standard hugo highlighter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/32">#32</a></li>
<li>[<strong>bug</strong>] theme: remove superfluous singular taxonomy from taxonomy title <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/46">#46</a></li>
<li>[<strong>bug</strong>][<strong>change</strong>] theme: missing –MENU-HOME-LINK-HOVER-color in documentation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/45">#45</a></li>
<li>[<strong>bug</strong>] theme: fix home link when base URL has some path <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/44">#44</a></li>
<li>[<strong>feature</strong>] attachments: adjust style between notice boxes and attachments <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/28">#28</a></li>
<li>[<strong>feature</strong>] notice: make restyling of notice boxes more robust <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/20">#20</a></li>
<li>[<strong>feature</strong>] notice: align box colors to common standards <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/18">#18</a></li>
<li>[<strong>feature</strong>] notice: use distinct icons for notice box type <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/17">#17</a></li>
<li>[<strong>bug</strong>] attachments: support i18n for attachment size <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/21">#21</a></li>
<li>[<strong>bug</strong>] notice: support i18n for box labels <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/16">#16</a></li>
<li>[<strong>bug</strong>] notice: support multiple blocks in one box <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/15">#15</a></li>
<li>[<strong>task</strong>] theme: prepare for new hugo theme registration <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/13">#13</a></li>
<li>[<strong>bug</strong>] mermaid: config option for CDN url not used <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/12">#12</a></li>
<li>[<strong>bug</strong>] mermaid: only highlight text in HTML elements <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/10">#10</a></li>
<li>[<strong>bug</strong>] mermaid: support pan & zoom for graphs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/9">#9</a></li>
<li>[<strong>bug</strong>] mermaid: code fences not always rendered <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/6">#6</a></li>
<li>[<strong>bug</strong>] mermaid: search term on load may bomb chart <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/5">#5</a></li>
