<p><ahref="#R-image-b70178534d29e81ba85f81bef789e5e1"class="lightbox-link"><imgsrc="./images/hero.png?width=100%25&height=100%25"alt="Image of the Relearn theme in light and dark mode on phone, tablet and desktop"class="figure-image bg-white border lightbox noshadow"style="height: auto; width: auto;"loading="lazy"></a>
<ahref="javascript:history.back();"class="lightbox-back"id="R-image-b70178534d29e81ba85f81bef789e5e1"><imgsrc="./images/hero.png?width=100%25&height=100%25"alt="Image of the Relearn theme in light and dark mode on phone, tablet and desktop"class="lightbox-image bg-white border lightbox noshadow"loading="lazy"></a></p>
<p>The theme is a fork of the great <ahref="https://github.com/matcornic/hugo-theme-learn"target="_blank">Learn theme</a> with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.</p>
<li><ahref="./basics/configuration/#serving-your-page-from-the-filesystem">Usable from your local file system via <code>file://</code> protocol</a></li>
<li>Support for the <ahref="https://github.com/estruyf/vscode-front-matter"target="_blank">VSCode Front Matter extension</a> for on-premise CMS capabilities</li>
<p>To get support, feel free to open a new <ahref="https://github.com/McShelby/hugo-theme-relearn/discussions"target="_blank">discussion topic</a> or <ahref="https://github.com/McShelby/hugo-theme-relearn/issues"target="_blank">issue report</a> in the official repository on GitHub.</p>
<p>You are most welcome to contribute bugfixes or new features by making pull requests to the <ahref="https://github.com/McShelby/hugo-theme-relearn"target="_blank">official repository</a>. Check the <ahref="./dev/contributing/">contribution guidelines</a> first before starting.</p>
<p>The Relearn theme is licensed under the <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE"target="_blank">MIT License</a>.</p>
<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><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Breaking</span></span> A change that requires action by you after upgrading to assure the site is still functional.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> A change in default behavior that may requires action by you if you want to revert it.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Marks new behavior you might find interesting or comes configurable.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> It is now possible to print custom taxonomies anywhere in you page. <ahref="./cont/taxonomy/#customization">See the docs</a>.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> It is now possible to adjust the menu width for your whole site. <ahref="./basics/customization/#change-the-menu-width">See the docs</a>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The theme now provides a mechanism to load further JavaScript dependencies defined by you. This comes in handy if you want to add your own shortcodes that require additional JavaScript code to be loaded. <ahref="./basics/customization/#own-shortcodes-with-javascript-dependencies">See the docs</a>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. <ahref="./basics/configuration/#social-media-meta-tags">See the docs</a>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> This release comes with additional sort options for the menu and the <ahref="./shortcodes/children/"><code>children</code> shortcode</a>. Both will now accept the following values: <code>weight</code>, <code>title</code>, <code>linktitle</code>, <code>modifieddate</code>, <code>expirydate</code>, <code>publishdate</code>, <code>date</code>, <code>length</code> or <code>default</code> (adhering to Hugo’s default sort order).</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> This release fixes an issue where in unfortunate conditions DOM ids generated by Hugo may collide with DOM ids set by the theme. To avoid this, all theme DOM ids are now prefixed with <code>R-</code>.</p>
<p>If you haven’t modified anything, everything is fine. Otherwise you have to check your custom CSS rules and JavaScript code.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> You can now have structural sections in the hierarchical menu without generating a page for it.</p>
<p>This can come in handy, if content for such a section page doesn’t make much sense to you. See <ahref="./cont/pages/#disable-section-pages">the documentation</a> for how to do this.</p>
<p>This feature may require you to make changes to your existing installation if you are already using <em><ahref="./cont/menushortcuts/#shortcuts-to-pages-inside-of-your-project">shortcuts to pages inside of your project</a></em> with a <em>headless branch parent</em>.</p>
<p>In this case it is advised to remove the <code>title</code> from the headless branch parent’s frontmatter, as it will otherwise appear in your breadcrumbs.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> It is now possible to overwrite the setting for <code>collapsibleMenu</code> of your <code>config.toml</code> inside of a page’s frontmatter.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> If a Mermaid graph is zoomable a button to reset the view is now added to the upper right corner. The button is only shown once the mouse is moved over the graph.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> It is now possible to remove the root breadcrumb by setting <code>disableRootBreadcrumb=true</code> in your <code>config.toml</code>.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The output of the dedicated search page now displays the result’s breadcrumb.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Table rows now change their background color on every even row.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translation into Swahili. This language is not supported for search.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your <code>menu-footer.html</code><ahref="./basics/customization/">partial overridden</a>, you may want to review the styling (eg. margins/paddings) of your partial.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See <ahref="./basics/topbar/">the documentation</a> for further details.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The theme has updated its Swagger dependency to 5.7.2 for the <ahref="./shortcodes/openapi/"><code>openapi</code> shortcode</a>. This brings support for OpenAPI Specification 3.1.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The theme has updated its Swagger dependency to 5.4.1 for the <ahref="./shortcodes/openapi/"><code>openapi</code> shortcode</a>.</p>
<p>With this comes a change in the light theme variants of <code>Relearn Bright</code>, <code>Relearn Light</code> and <code>Zen Light</code> by switching the syntaxhighlightning inside of openapi to a light scheme. This brings it more in sync with the code style used by the theme variants itself.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> For consistency reasons, we renamed the CSS variable <code>--MENU-SECTION-HR-color</code> to <code>--MENU-SECTION-SEPARATOR-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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The theme variants <code>Zen Light</code> and <code>Zen Dark</code> now add more contrast between menu, topbar and content by adding thin borders.</p>
<p>Those borders are now configurable by using the CSS variables <code>--MAIN-TOPBAR-BORDER-color</code>, <code>--MENU-BORDER-color</code>, <code>--MENU-TOPBAR-BORDER-color</code>, <code>--MENU-TOPBAR-SEPARATOR-color</code>, <code>--MENU-HEADER-SEPARATOR-color</code> and <code>--MENU-SECTION-ACTIVE-CATEGORY-BORDER-color</code>.</p>
<p>For existing variants nothing has changed visually.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The default values for the <ahref="./cont/markdown/#image-effects">image effects</a> are <ahref="./cont/imageeffects/">now configurable</a> for your whole site via <code>config.toml</code> or for each page thru frontmatter.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> This release fixes a long outstanding bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed <code>expand</code> or inactive <code>tabs</code>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Restored compatibility with Hugo versions lower than <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.111.0</span></span> for the <ahref="./shortcodes/highlight/"><code>highlight</code> shortcode</a>. This does not change the minimum required Hugo version.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The <ahref="./shortcodes/highlight/"><code>highlight</code> shortcode</a> now accepts the new parameter <code>title</code>. This displays the code like a <ahref="./shortcodes/tab/">single tab</a>. This is also available using codefences and makes it much easier to write nicer code samples.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The theme has added two new color variants <code>zen-light</code> and <code>zen-dark</code>. Check it out!</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The theme now <ahref="./basics/customization/#javascript">dispatches the custom event</a><code>themeVariantLoaded</code> on the <code>document</code> when the variant is fully loaded either initially or by switching the variant manually with the variant selector.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The theme has updated its Mermaid dependency to 10.3.1. This adds support for the <ahref="./shortcodes/mermaid/#sankey">sankey diagram type</a> and now comes with full support for YAML inside Mermaid graphs (previously, the theme ignored explicit Mermaid theme settings in YAML).</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translation into Hungarian.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The theme adds additional warnings for deprecated or now unsupported features. The warnings include hints how to fix them and an additional link to the documenation.</p>
<p><code>DEPRECATION</code> warnings mark features that still work but may be removed in the future.</p>
<p><code>UNSUPPORTED</code> warnings mark features that will not work anymore.</p>
</li>
<li>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> There are visual improvements in displaying text links in your content aswell as to some other clickable areas in the theme. If you’ve overwritten some theme styles in your own CSS, keep this in mind.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Restored compatibility with Hugo <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.95.0</span></span> or higher. This does not change the minimum required Hugo version.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The <ahref="./shortcodes/siteparam/"><code>siteparam</code> shortcode</a> is now capable in displaying nested params aswell as supporting text formatting.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The default behavior for the copy-to-clipboard feature for code blocks has changed.</p>
<p>The copy-to-clipboard button for code blocks will now only be displayed if the reader hovers the code block.</p>
<p>If you dislike this new behavior you can turn it off and revert to the old behavior by adding <code>[params] disableHoverBlockCopyToClipBoard=true</code> to your <code>config.toml</code>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Restored compatibility with Hugo <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.114.0</span></span> or higher. This does not change the minimum required Hugo version.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The new <ahref="./shortcodes/highlight/"><code>highlight</code> shortcode</a> replaces Hugo’s default implementation and is fully compatible. So you don’t need to change anything.</p>
<p>In addition it offers some extensions. Currently only the <code>wrap</code> extension option is provided to control whether a code block should be wrapped or scrolled if to long to fit.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The theme now provides warnings for deprecated or now unsupported features. The warnings include hints how to fix them and an additional link to the documenation.</p>
<p><code>DEPRECATION</code> warnings mark features that still work but may be removed in the future.</p>
<p><code>UNSUPPORTED</code> warnings mark features that will not work anymore.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The 404 error page was revamped. Hopefully you will not see this very often.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The <ahref="./shortcodes/tabs/"><code>tabs</code> shortcode</a> and the <ahref="./shortcodes/tab/"><code>tab</code> shortcode</a> received some love and now align with their style, color, title and icon parameter to the other shortcodes.</p>
<p>The visuals are now slightly different compared to previous versions. Most noteable, if you now display a single code block in a tab, its default styling will adapt to that of a code block but with a tab handle at the top.</p>
<p>Additionally the <code>name</code> parameter was renamed to <code>title</code> but you don’t need to change anything yet as the old name will be used as a fallback. Nevertheless you will get deprecation warnings while executing Hugo.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The theme now optionally supports <ahref="./basics/customization/#change-the-favicon">separate favicons</a> for light & dark mode.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Restored compatibility with Hugo <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.112.0</span></span> or higher. This does not change the minimum required Hugo version.</p>
<p>The <ahref="./shortcodes/attachments/"><code>attachments</code> shortcode</a> has compatiblity issues with newer Hugo versions. You must switch to leaf bundles or are locked to Hugo <<code>0.112.0</code> for now.</p>
<p>It is <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/22"target="_blank">planned to refactor</a> the <code>attchments</code> shortcode in the future. This will make it possible to use the shortcode in branch bundles again but not in simple pages anymore. This will most likely come with a breaking change.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The <ahref="./shortcodes/tabs/"><code>tabs</code> shortcode</a> has changed behavior if you haven’t set the <code>groupid</code> parameter.</p>
<p>Formerly all tab views without a <code>groupid</code> were treated as so they belong to the same group. Now, each tab view is treated as it was given a unique id.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The already known <code>tabs</code>has a new friend the <ahref="./shortcodes/tab/"><code>tab</code> shortcode</a> to make it easier to create a tab view in case you only need one single tab. Really handy if you want to flag your code examples with a language identifier.</p>
<p>Additionally for such a use case, the whitespace between a tab outline and the code is removed if only a single code block is contained.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Besides the <em>tag</em><ahref="./cont/taxonomy/">taxonomy</a> the theme now also provides the <em>category</em> taxonomy out of the box and shows them in the content footer of each page.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The taxonomy pages received some love in this release, making them better leverage available screen space and adding translation support for the taxonomy names.</p>
<p>Hugo’s default taxonmies <code>tags</code> and <code>categories</code> are already contained in the theme’s i18n files. If you have self-defined taxonomies, you can add translations by adding them to your own i18n files. If you don’t provide translations, the singualar and plural forms are taken as configured in your <code>config.toml</code>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> To give you more flexibility in customizing your article layout a new partial <code>content-header.html</code> is introduced.</p>
<p>This came out of the requirement to customize the position of article tags, which by default are displayed above the title. A second requirement was to also show additional <ahref="https://gohugo.io/content-management/taxonomies/"target="_blank">taxonomies</a> not supported by the theme natively. While Hugo supports tags and categories by default, the theme only displays tags.</p>
<p>So how to adjust the position of tags starting from the theme’s default where tags are only shown above the title?</p>
<li>Show tags between title and content: Overwrite <code>heading-post.html</code> and add <code>{{- partial "tags.html" . }}</code> to it.</li>
<li>Show tags below content: Overwrite <code>content-footer.html</code> and add <code>{{- partial "tags.html" . }}</code> to it.</li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The new parameter <code>breadcrumbSeparator</code> is now available in your <code>config.toml</code> to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The <code>swagger</code> shortcode was deprecated in favor for the <ahref="./shortcodes/openapi/"><code>openapi</code> shortcode</a>. You don’t need to change anything yet as the old name will be used as a fallback. It is planned to remove the <code>swagger</code> shortcode in the next major release.</p>
<p>Additionally, the implemantion of this shortcode was switched from RapiDoc to <ahref="https://github.com/swagger-api/swagger-ui"target="_blank">SwaggerUI</a>.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed (again). While Internet Explorer 11 has issues in displaying it, the functionality still works.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Support for the great <ahref="https://github.com/estruyf/vscode-front-matter"target="_blank">VSCode Front Matter extension</a> which provides on-premise CMS capabilties to Hugo.</p>
<p>The theme provides Front Matter snippets for its shortcodes. Currently only English and German is supported. Put a reference into your <code>frontmatter.json</code> like this</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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. You can experience this in the <ahref="./pir/basics/migration/">pirate translation</a>. This feature is not available in Internet Explorer 11.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The scrollbars are now colored according to their variant color scheme to better fit into the visuals.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The theme removed the popular <ahref="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span><ahref="./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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The theme is now capable to visually <ahref="./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><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The JavaScript code for handling image lightboxes (provided by <ahref="https://noelboss.github.io/featherlight"target="_blank">Featherlight</a>) was replaced by a CSS-only solution.</p>
<p>This also changed the <ahref="./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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> In the effort to comply with WCAG standards, the implementation of the <ahref="./shortcodes/expand/"><code>expand</code> shortcode</a> was changed. While Internet Explorer 11 has issues in displaying it, the functionality still works.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translation into Czech. This language is not supported for search.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span><ahref="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The <ahref="./shortcodes/attachments/"><code>attachments</code></a>, <ahref="./shortcodes/badge/"><code>badge</code></a>, <ahref="./shortcodes/button/"><code>button</code></a> and <ahref="./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>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Breaking</span></span> With this version it is now possible to not only have sections on the first menu level but also pages.</p>
<p>It was later discovered, that this causes pages only meant to be displayed in the <code>More</code> section of the menu and stored directly inside your <code>content</code> directory to now show up in the menu aswell.</p>
<p>Make the page file a <ahref="https://gohugo.io/content-management/age-bundles/#headless-bundle"target="_blank">headless branch bundle</a> (contained in its own subdirectory and called <code>_index.md</code>) and add the following frontmatter configuration to the file (see exampleSite’s <code>content/showcase/_index.en.md</code>). This causes its content to <strong>not</strong> be ontained in the sitemap.</p>
<p>Store the page file for below a parent headless branch bundle and add the following frontmatter to he <strong>parent</strong> (see exampleSite’s <code>content/more/_index.en.md</code>).</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="c"># title = "More" ### ATTENTION: Don't give this page a title as this will cause it to be in the breadcrumbs - a thing you most likely don't want</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">publishResources</span><spanclass="p">=</span><spanclass="kc">false</span></span></span></code></pre></div><p>In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s <code>content/more/credits.en.md</code>). This causes its content to be contained in the sitemap.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> The required folder name for the <ahref="./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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The theme now supports <ahref="https://gohugo.io/hugo-modules/"target="_blank">Hugo’s module system</a>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The new <ahref="./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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The new <ahref="./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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely <ahref="./cont/markdown/#tasks">task lists</a>, <ahref="./cont/markdown/#defintions">defintion lists</a> and <ahref="./cont/markdown/#footnotes">footnotes</a>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> 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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The search now supports the Korean language.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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 <ahref="./cont/markdown/#image-effects">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><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span><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><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> 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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> 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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translation into Finnish (Suomi).</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span><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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Printing for the <ahref="./shortcodes/openapi/"><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><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.95.0</span></span> This release requires a newer Hugo version.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> 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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> 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><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Breaking</span></span> 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><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> 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><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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 and will point to the project’s homepage. If you want to support a different link, overwrite the <code>logo.html</code> partial.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> 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><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> 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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translation into Polish. This language is not supported for search.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The documentation for all shortcodes were revised.</p>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> 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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Translation into Traditional Chinese.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <ahref="./basics/generator/">theme variant generator</a> of the exampleSite for all available variables.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The new shortcode <code>swagger</code> is available to include a UI for REST OpenAPI specifications. See the <ahref="./shortcodes/openapi/">documentation</a> for available features. This feature will not work with Internet Explorer 11.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.93.0</span></span> This release requires a newer Hugo version.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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 <ahref="./basics/generator/">theme variant generator</a> of the exampleSite for an example.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span><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"target="_blank">Font Awesome 5 Free</a> icons.</li>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Breaking</span></span> 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>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>. <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><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> 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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <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><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="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>
<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"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 <ahref="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>
<divclass="wrap-code 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>
<p>Start up a text editor with regular expression support for search and replace. Search for <code>(ref\s+"[^"]*?)(?:/_index|/index)?(?:\.md)?(#[^"]*?)?"</code> and replace it by <code>$1$2"</code> in all <code>*.md</code> files. <strong>This is the recommended choice</strong>.</p>
<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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <ahref="./basics/configuration/#global-site-parameters">the example configuration</a>.</p>
<li><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Optional second parameter for <ahref="./shortcodes/notice/"><code>notice</code></a> shortcode to set title in box header.</li>
<li><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <ahref="./basics/configuration/#a-word-on-running-your-site-in-a-subfolder">documentation</a> for a detailed example.</li>
<li><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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 <ahref="./cont/pages/#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and default behavior.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> 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"target="_blank">Hugo documentation</a>.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.81.0</span></span> This release requires a newer Hugo version.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.69.0</span></span> This release requires a newer Hugo version.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> If a search term is found in an <code>expand</code> shortcode, the expand will be opened.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> The menu will scroll the active item into view on load.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> Syntax highlighting was switched to the <ahref="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="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>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.</p>
<p><spanclass="badge cstyle note badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-circle"></i></span><spanclass="badge-content">Change</span></span> A page without a <code>title</code> will be treated as <code>hidden=true</code>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> 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><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> New partials for defining pre/post content for menu items and the content. See <ahref="./basics/customization/">documentation</a> for further reading.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Shortcode <ahref="./shortcodes/children/"><code>children</code></a> with new parameter <code>containerstyle</code>.</p>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> New shortcode <ahref="./shortcodes/include/"><code>include</code></a> to include arbitrary file content into a page.</p>
<li><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Shortcode <ahref="./shortcodes/expand/"><code>expand</code></a> with new parameter to open on page load.</li>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Breaking</span></span><ahref="./shortcodes/mermaid/">Mermaid</a> diagrams can now be panned and zoomed. This isn’t configurable yet.</p>
</li>
<li>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span><ahref="./shortcodes/mermaid/#configuration"><code>Mermaid</code></a> config options can be set in <code>config.toml</code>.</p>
<p><spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="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>
<p><spanclass="badge cstyle info badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-plus-circle"></i></span><spanclass="badge-content">New</span></span> Initial fork of the <ahref="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 <ahref="https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495"target="_blank">this comment</a> in the Learn issues.</p>
<p>Just download at least version <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.95.0</span></span> of the <ahref="https://gohugo.io/getting-started/installing/"target="_blank">Hugo binary</a> for your OS (Windows, Linux, Mac).</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/"target="_blank">great documentation for beginners</a>.</p>
<divclass="wrap-code highlight"><pretabindex="0"><code>hugo new site <new_project></code></pre></div><h2id="install-the-theme">Install the theme</h2>
<p>Install the Relearn theme by following <ahref="https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme"target="_blank">this documentation</a> using Hugo’s module system.</p>
<p>This theme’s repository is: <ahref="https://github.com/McShelby/hugo-theme-relearn.git"target="_blank">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"target="_blank">download the theme as .zip</a> file and extract it in the <code>themes</code> directory</p>
<p>If you install the theme from your git repository or GitHub, you have several options.</p>
<p>If you use the <code>head</code> of the <code>main</code> branch, you are using the development version. Usually it is fully functional but can break from time to time. We try to fix newly introduced bugs in this version as soon as possible.</p>
<p>Additionally you can checkout one of the tagged versions. These tagged versions correspond to an official <ahref="https://github.com/McShelby/hugo-theme-relearn/releases"target="_blank">releases from the GitHub repository</a>.</p>
<p>Besides the usual version tags (eg <code>1.2.3</code>) there are also tags for the main version (eg. <code>1.2.x</code>), major version (eg. <code>1.x</code>) and the latest (just <code>x</code>) released version making it easier for you to pin the theme to a certain version.</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="wrap-code 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><spanclass="line"><spanclass="cl"><spanclass="nx">home</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"HTML"</span><spanclass="p">,</span><spanclass="s2">"RSS"</span><spanclass="p">,</span><spanclass="s2">"SEARCH"</span><spanclass="p">]</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>
</span></span><spanclass="line"><spanclass="cl">Discover what this Hugo theme is all about and the core concepts behind it.</span></span></code></pre></div><p>renders as</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="wrap-code 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="wrap-code 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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo serve</span></span></code></pre></div><p>Go to <code>http://localhost:1313</code></p>
<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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo</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/"target="_blank">Netlify</a> (Read more about <ahref="https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/"target="_blank">Automated HUGO deployments with Netlify</a>). Alternatively, you can use <ahref="https://gohugo.io/hosting-and-deployment/hosting-on-github/"target="_blank">GitHub pages</a>.</p>
<p>On top of <ahref="https://gohugo.io/overview/configuration/"target="_blank">Hugo global configuration</a>, the Relearn theme lets you define the following parameters in your <code>config.toml</code> (here, values are default).</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"># Set this to true to disable the hover effect for copy-to-clipboard buttons for block code.</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 OpenAPI module on every page regardless if a OpenAPI shortcode is present</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Order menu sections by "weight", "title", "linktitle", "modifieddate", "expirydate", "publishdate", "date", "length" or "default" (adhering to Hugo's default sort order). Default to "weight";</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Change default color scheme with a variant one. Eg. can be "auto", "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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># For external links you can define how they are opened in your browser; this setting will only be applied to the content area but not the shortcut menu</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Override default values for image effects, you can even add your own arbitrary effects to the list</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">shadow</span><spanclass="p">=</span><spanclass="kc">false</span></span></span></code></pre></div><h2id="serving-your-page-from-a-subfolder">Serving your page from a subfolder</h2>
<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><spanclass="line"><spanclass="cl"><spanclass="nx">relativeURLs</span><spanclass="p">=</span><spanclass="kc">true</span></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"target="_blank">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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="nx">relativeURLs</span><spanclass="p">=</span><spanclass="kc">true</span></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><spanclass="line"><spanclass="cl"><spanclass="nx">home</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"HTML"</span><spanclass="p">,</span><spanclass="s2">"RSS"</span><spanclass="p">,</span><spanclass="s2">"SEARCH"</span><spanclass="p">]</span></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 search library. 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. This will cause Hugo to generate a new file <code>http://example.com/mysite/search.html</code>.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">home</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"HTML"</span><spanclass="p">,</span><spanclass="s2">"RSS"</span><spanclass="p">,</span><spanclass="s2">"SEARCH"</span><spanclass="p">,</span><spanclass="s2">"SEARCHPAGE"</span><spanclass="p">]</span></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>
<p><ahref="#R-image-c8e501f86fa3e42016ced892b7ee1f77"class="lightbox-link"><imgsrc="./basics/configuration/search_page.png?&width=60pc"alt="Screenshot of the dedicated search page"class="figure-image bg-white border lightbox noshadow"style="height: auto; width: 60pc;"loading="lazy"></a>
<ahref="javascript:history.back();"class="lightbox-back"id="R-image-c8e501f86fa3e42016ced892b7ee1f77"><imgsrc="./basics/configuration/search_page.png?&width=60pc"alt="Screenshot of the dedicated search page"class="lightbox-image bg-white border lightbox noshadow"loading="lazy"></a></p>
<p>To have Hugo create the dedicated search page successfully, you must not generate the URL <code>http://example.com/mysite/search.html</code> from your own content. This can happen if you set <code>uglyURLs=true</code> in your <code>config.toml</code> and defining a Markdown file <code>content/search.md</code>.</p>
<p>To make sure, there is no duplicate content for any given URL of your project, run <code>hugo --printPathWarnings</code>.</p>
<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><spanclass="line"><spanclass="cl"><spanclass="nx">page</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"HTML"</span><spanclass="p">,</span><spanclass="s2">"RSS"</span><spanclass="p">,</span><spanclass="s2">"PRINT"</span><spanclass="p">]</span></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"target="_blank">configured ugly</a> in terms of <ahref="https://gohugo.io/content-management/urls/#ugly-urls"target="_blank">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>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p">...</span></span></span></code></pre></div><p>If those params are not configured for a specific language, they will get their
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="nx">landingPageName</span><spanclass="p">=</span><spanclass="s2">"<i class='fas fa-home'></i> Home"</span></span></span></code></pre></div><p>The home button is going to look like this:</p>
<p>You can add social media meta tags for the <ahref="https://gohugo.io/templates/internal/#open-graph"target="_blank">Open Graph</a> protocol and <ahref="https://gohugo.io/templates/internal/#twitter-cards"target="_blank">Twitter Cards</a> to your site. These are configured as mentioned in the Hugo docs.</p>
<p>The Relearn theme has been built to be as configurable as possible by defining multiple <ahref="https://gohugo.io/templates/partials/"target="_blank">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/"target="_blank">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>
<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>Additionally, if you want your site to use light & dark theme favicons that follow the OS’ (and in some cases, the browser’s) color scheme, add the image files to your local <code>static/images/</code> folder and name them eg. <code>favicon-light.svg</code> and/or <code>favicon-dark.svg</code> respectively corresponding to your file format. In case one of the files is missing, the theme falls back to eg. <code>favicon.svg</code> for the missing file. All supplied favicons must be of the same file format.</p>
<p>IE and old browser versions do not support <ahref="https://caniuse.com/css-media-interaction"target="_blank">media queries</a>, which are necessary for the light & dark theme favicon option.
If you have requirements to support IE and/or older browser versions, use one of the other options.</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>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl"><spanclass="p"><</span><spanclass="nt">link</span><spanclass="na">rel</span><spanclass="o">=</span><spanclass="s">"icon"</span><spanclass="na">href</span><spanclass="o">=</span><spanclass="s">"/images/favicon.bmp"</span><spanclass="na">type</span><spanclass="o">=</span><spanclass="s">"image/bmp"</span><spanclass="p">></span></span></span></code></pre></div><h2id="change-the-menu-width">Change the Menu Width</h2>
<p>The menu width adjusts automatically for different screen sizes.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Screen Width</th>
<th>Menu Width</th>
</tr>
</thead>
<tbody>
<tr>
<td>S</td>
<td>< 48rem</td>
<td>0</td>
</tr>
<tr>
<td>M</td>
<td>48rem - 60rem</td>
<td>14.375rem</td>
</tr>
<tr>
<td>L</td>
<td>>= 60rem</td>
<td>18.75rem</td>
</tr>
</tbody>
</table>
<p>The values for the screen width breakpoints aren’t configurable.</p>
<p>If you want to adjust the menu width you can define the following CSS variables in your <code>custom-header.html</code>. Note that <code>--MENU-WIDTH-S</code> doesn’t exist as the menu is always hidden for small screen sizes.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">themeVariant</span><spanclass="p">=</span><spanclass="s2">"relearn-light"</span></span></span></code></pre></div><p>In the above example your theme file has to be named <code>theme-relearn-light.css</code></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/"target="_blank">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>
<h3id="adjust-to-os-settings">Adjust to OS Settings</h3>
<p>You can also cause the site to adjust to your OS settings for light/dark mode. Just set the <code>themeVariant</code> to <code>auto</code>. That’s it.</p>
<p>If you’ve set multiple variants, you can drop <code>auto</code> at any position, but usually it makes sense to set it in the first position and make it the default.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">themeVariant</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"auto"</span><spanclass="p">,</span><spanclass="s2">"red"</span><spanclass="p">]</span></span></span></code></pre></div><p>If you don’t configure anything else, the theme will use <code>relearn-light</code> for light mode and <code>relearn-dark</code> for dark mode.</p>
<p>If you don’t like that, you can set <code>themeVariantAuto</code>. The first element is the variant for light mode, the second for dark mode</p>
<p>Once a variant is fully loaded, either initially or by switching the variant manually with the variant selector, the custom event <code>themeVariantLoaded</code> on the <code>document</code> will be dispatched. You can add an event listener and react to changes.</p>
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="c1"></span><spanclass="p">});</span></span></span></code></pre></div><h3id="roll-your-own">Roll your Own</h3>
<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>
<h2id="own-shortcodes-with-javascript-dependencies">Own Shortcodes with JavaScript Dependencies</h2>
<p>Certain shortcodes make use of additional JavaScript files. The theme only loads these dependencies if the shortcode is used. To do so correctly the theme adds management code in various files. To provide this behavior to the user and extending it for his own shortcodes this can be configured.</p>
<p>Say you want to add a shortcode <code>myshortcode</code> that also requires the <code>jquery</code> JavaScript library.</p>
<p>Add the dependency loader file <code>layouts/partials/dependencies/myshortcode.html</code>. The loader file will be appended to your header or footer, dependend on the <code>location</code> setting in your <code>config.toml</code>.</p>
<li>the <code>name</code> setting in your <code>config.toml</code> must match the key (that needs to be prefixed with a <code>has</code>) you used for the store in your <code>layouts/shortcodes/myshortcode.html</code>.</li>
<p>Certain parts of the theme can be changed for support of your own <ahref="https://gohugo.io/templates/output-formats/"target="_blank">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>To get started, first select a color variant from the variant switch in the lower left sidebar 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 <strong>and the page</strong> will update accordingly.</p>
<p>The arrowed lines reflect 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 <strong>browse to other pages</strong> and even close the browser <strong>without losing your changes</strong>.</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>
<p><ahref="#R-image-7409f2b29d487d764fa313fec3c38a42"class="lightbox-link"><imgsrc="./basics/topbar/topbar-closed.png"alt="Topbar on mobile devices"class="figure-image bg-white border lightbox noshadow"style="height: auto; width: auto;"loading="lazy"></a>
<ahref="javascript:history.back();"class="lightbox-back"id="R-image-7409f2b29d487d764fa313fec3c38a42"><imgsrc="./basics/topbar/topbar-closed.png"alt="Topbar on mobile devices"class="lightbox-image bg-white border lightbox noshadow"loading="lazy"></a></p>
<p>Nevertheless, your requirements may differ from this configuration. Luckily the theme got you covered as the themebar, its buttons and the functionality behind these buttons is fully configurable by you.</p>
<p><ahref="#R-image-50cd520cb2bd67d064aa4f95e848a891"class="lightbox-link"><imgsrc="./basics/topbar/topbar-areas.png"alt="Topbar with default areas marked"class="figure-image bg-white border lightbox noshadow"style="height: auto; width: auto;"loading="lazy"></a>
<ahref="javascript:history.back();"class="lightbox-back"id="R-image-50cd520cb2bd67d064aa4f95e848a891"><imgsrc="./basics/topbar/topbar-areas.png"alt="Topbar with default areas marked"class="lightbox-image bg-white border lightbox noshadow"loading="lazy"></a></p>
<li><ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/start.html"target="_blank"><strong>start</strong></a>: shown between menu and breadcrumb</li>
<li><ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/end.html"target="_blank"><strong>end</strong></a>: shown on the opposite breadcrumb side in comparison to the <em>start</em> area</li>
<li><ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/more.html"target="_blank"><strong>more</strong></a>: shown when pressing the
<p>While you can not add additional areas in the topbar, you are free to configure addtional buttons that behave like the <em>more</em> button, providing further user defined areas.</p>
<h2id="buttons">Buttons</h2>
<p>The theme ships with the following predefined buttons (from left to right in the screenshot)</p>
</span><ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/sidebar.html"target="_blank"><strong>sidebar</strong></a>: opens the sidebar flyout if in mobile layout</li>
</span><ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/toc.html"target="_blank"><strong>toc</strong></a>: opens the table of contents in an overlay</li>
</span><ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/edit.html"target="_blank"><strong>edit</strong></a>: browses to the editable page if the <code>editURL</code><ahref="./basics/configuration/#global-site-parameters">parameter is set</a></li>
</span><ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html"target="_blank"><strong>print</strong></a>: browses to the chapters printable page if <ahref="./basics/configuration/#activate-print-support">print support</a> was activated</li>
</span><ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/prev.html"target="_blank"><strong>prev</strong></a>: browses to the previous page if there is one</li>
</span><ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/next.html"target="_blank"><strong>next</strong></a>: browses to the next page if there is one</li>
</span><ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/more.html"target="_blank"><strong>more</strong></a>: opens the overlay for the <em>more</em> area</li>
<p>Not all buttons are displayed at every given time. This is configurable (see below if interested).</p>
<h2id="redefining-areas">Redefining Areas</h2>
<p>Each predefined area and button comes in their own file. By that it is easy for you to overwrite an area file in your installation reusing only the buttons you like.</p>
<p>Eg. you can redefine the predefined <em>end</em> area by adding the file <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/area/end.html"target="_blank"><code>layouts/partials/topbar/area/end.html</code></a> in your installation (not in the theme itself) to remove all but the <em>more</em> button.</p>
<p>The below example sets an explicit value for the <code>onempty</code> parameter, overriding the specific default value for this button (these defaults vary depending on the button). The parameter causes the <em>more</em> button to always be displayed instead of hiding once its content is empty.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p">)}}</span></span></span></code></pre></div><h2id="defining-own-buttons">Defining own Buttons</h2>
<h3id="button-types">Button Types</h3>
<p>The theme distingushies between two types of buttons:</p>
<li><ahref="#button"><strong>button</strong></a>: a clickable button that either browses to another site, triggers a user defined script or opens an overlay containing user defined content</li>
</span><em>more</em> button, to define your own area overlay buttons</li>
</ul>
<h3id="button-parameter">Button Parameter</h3>
<h4id="screen-widths-and-actions">Screen Widths and Actions</h4>
<p>Depending on the screen width you can configure how the button should behave. Screen width is divided into three classes:</p>
<ul>
<li><strong>s</strong>: (controlled by the <code>onwidths</code> parameter) mobile layout where the menu sidebar is hidden</li>
<li><strong>m</strong>: (controlled by the <code>onwidthm</code> parameter) desktop layout with visible sidebar while the content area width still resizes</li>
<li><strong>l</strong>: (controlled by the <code>onwidthl</code> parameter) desktop layout with visible sidebar once the content area reached its maximum width</li>
</ul>
<p>For each width class, you can configure one of the following actions:</p>
<li><code>show</code>: the button is displayed in its given area</li>
<li><code>hide</code>: the button is removed</li>
<li><code>area-XXX</code>: the button is moved from its given area into the area <code>XXX</code>; eg. this is used to move buttons to the <em>more</em> area overlay in the mobile layout</li>
<h4id="hiding-and-disabling-stuff">Hiding and Disabling Stuff</h4>
<p>While hiding a button dependend on the screen size can be configured with the above described <em>hide</em> action, you may want to hide the button on certain other conditions aswell.</p>
<p>For example, the <em>print</em> button in its default configuration should only be displayed if print support was configured. This is done in your button template by checking the conditions first before displaying the button (see <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html"target="_blank"><code>layouts/partials/topbar/button/print.html</code></a>).</p>
<p>Another prefered condition for hiding a button is, if the displayed overlay is empty. This is the case for the <em>toc</em> (see <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/toc.html"target="_blank"><code>layouts/partials/topbar/button/toc.html</code></a>) aswell as the <em>more</em> button (see <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/more.html"target="_blank"><code>layouts/partials/topbar/button/more.html</code></a>) and controlled by the parameter <code>onempty</code>.</p>
<p>If you want to disable a button containing <em>no overlay</em>, this can be achieved by an empty <code>href</code> parameter. An example can be seen in the <em>prev</em> button (see <code>layouts/partials/topbar/button/prev.html</code>) where the URL for the previous site may be empty.</p>
<p>Contains the basic button functionality and is used as a base implementation for all other buttons (<ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/func/button.html"target="_blank"><code>layouts/partials/topbar/func/button.html</code></a>).</p>
<p>Call this from your own button templates if you want to implement a button without an overlay like the <em>print</em> button (<ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/print.html"target="_blank"><code>layouts/partials/topbar/button/print.html</code></a>) or with an overlay containing arbitrary content like the <em>toc</em> button (<ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/toc.html"target="_blank"><code>layouts/partials/topbar/button/toc.html</code></a>).</p>
<td>Either the destination URL for the button or JavaScript code to be executed on click.<br><br>- if starting with <code>javascript:</code> all following text will be executed in your browser<br>- every other string will be interpreted as URL<br>- if empty the button will be displayed in disabled state regardless of its <strong>content</strong></td>
<td>Defines what to do with the button if <strong>href</strong> is not empty but the content overlay is empty:<br><br>- <code>disable</code>: The button is displayed in disabled state.<br>- <code>hide</code>: The button is removed.</td>
<td>The action, that should be executed if the site is displayed in the given width:<br><br>- <code>show</code>: The button is displayed in its given area<br>- <code>hide</code>: The button is removed.<br>- <code>area-XXX</code>: The button is moved from its given area into the area <code>XXX</code>.</td>
<p>Contains the basic functionality to display area overlay buttons (<ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/func/area-button.html"target="_blank"><code>layouts/partials/topbar/func/area-button.html</code></a>).</p>
<p>Call this from your own button templates if you want to implement a button with an area overlay like the <em>more</em> button (<ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button/more.html"target="_blank"><code>layouts/partials/topbar/button/more.html</code></a>).</p>
<td>Defines what to do with the button if the content overlay is empty:<br><br>- <code>disable</code>: The button is displayed in disabled state.<br>- <code>hide</code>: The button is removed.</td>
<td>The action, that should be executed if the site is displayed in the given width:<br><br>- <code>show</code>: The button is displayed in its given area<br>- <code>hide</code>: The button is removed.<br>- <code>area-XXX</code>: The button is moved from its given area into the area <code>XXX</code>.</td>
<p>The predefined buttons by the theme (all other buttons besides the <em>more</em> and <em>toc</em> button in <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button"target="_blank"><code>layouts/partials/topbar/button</code></a>).</p>
<td>The action, that should be executed if the site is displayed in the given width:<br><br>- <code>show</code>: The button is displayed in its given area<br>- <code>hide</code>: The button is removed.<br>- <code>area-XXX</code>: The button is moved from its given area into the area <code>XXX</code>.</td>
<p>The predefined buttons by the theme that open an overlay (the <em>more</em> and <em>toc</em> button in <ahref="https://github.com/McShelby/hugo-theme-relearn/blob/main/layouts/partials/topbar/button"target="_blank"><code>layouts/partials/topbar/button</code></a>).</p>
<td>Defines what to do with the button if the content overlay is empty:<br><br>- <code>disable</code>: The button is displayed in disabled state.<br>- <code>hide</code>: The button is removed.</td>
<td>The action, that should be executed if the site is displayed in the given width:<br><br>- <code>show</code>: The button is displayed in its given area<br>- <code>hide</code>: The button is removed.<br>- <code>area-XXX</code>: The button is moved from its given area into the area <code>XXX</code>.</td>
<li>[<strong>feature</strong>] math: hide unrendered math <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/663"target="_blank">#663</a></li>
<li>[<strong>feature</strong>] tabs: improve a11y by removing duplicate hidden title <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/662"target="_blank">#662</a></li>
<li>[<strong>bug</strong>] variant: fix sidebar-flyout borders color for zen <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/667"target="_blank">#667</a></li>
<li>[<strong>bug</strong>] clipboard: fix RTL location of tooltip <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/661"target="_blank">#661</a></li>
<li>[<strong>bug</strong>] clipboard: ignore RTL for code <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/660"target="_blank">#660</a></li>
<li>[<strong>bug</strong>] theme: fix id generation for markdownified titles <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/657"target="_blank">#657</a></li>
<li>[<strong>bug</strong>] mermaid: avoid graph bombing on hugo –minify <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/656"target="_blank">#656</a></li>
<li>[<strong>bug</strong>] mermaid: fix width for some graphs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/655"target="_blank">#655</a></li>
<li>[<strong>feature</strong>] markdown: add interlace color for tables <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/648"target="_blank">#648</a></li>
<li>[<strong>feature</strong>] search: add breadcrumb to dedicated search results <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/647"target="_blank">#647</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] menu: optionally disable index pages for sections <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/642"target="_blank">#642</a></li>
<li>[<strong>bug</strong>][<strong>change</strong>] theme: avoid id collisions between headings and theme <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/646"target="_blank">#646</a></li>
<li>[<strong>bug</strong>] theme: remove HTML validation errors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/644"target="_blank">#644</a></li>
<li>[<strong>bug</strong>] breadcrumb: remove superflous whitespace between items <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/643"target="_blank">#643</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: support for colored borders between menu and content <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/626"target="_blank">#626</a></li>
<li>[<strong>feature</strong>] image: allow option to apply image effects globally <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/623"target="_blank">#623</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] openapi: switch to light syntaxhighlightning where applicable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/621"target="_blank">#621</a></li>
<li>[<strong>feature</strong>] images: document usage of images with links <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/576"target="_blank">#576</a></li>
<li>[<strong>bug</strong>] highlight: fix rendering for Hugo < 0.111 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/630"target="_blank">#630</a></li>
<li>[<strong>bug</strong>] search: remove link underline on dedicated search page <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/627"target="_blank">#627</a></li>
<li>[<strong>bug</strong>] highlight: don’t switch to block view if hl_inline=true <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/618"target="_blank">#618</a></li>
<li>[<strong>bug</strong>] variant: minor adjustments to zen variants <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/617"target="_blank">#617</a></li>
<li>[<strong>bug</strong>] mermaid: lazy render graph if it is initially hidden <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/187"target="_blank">#187</a></li>
<li>[<strong>feature</strong>] highlight: add title parameter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/616"target="_blank">#616</a></li>
<li>[<strong>feature</strong>] variant: signal variant switch as event <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/614"target="_blank">#614</a></li>
<li>[<strong>feature</strong>] variant: add zen variant in light and dark <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/613"target="_blank">#613</a></li>
<li>[<strong>bug</strong>] siteparam: avoid halt if param is a map/slice <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/611"target="_blank">#611</a></li>
<li>[<strong>bug</strong>] mermaid: fix broken zoom since update to v10 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/608"target="_blank">#608</a></li>
<li>[<strong>bug</strong>] mermaid: variant generator diagram does not respond to events <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/607"target="_blank">#607</a></li>
<li>[<strong>bug</strong>] print: avoid chroma leak for relearn-dark <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/605"target="_blank">#605</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] shortcodes: add more deprecation warnings <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/598"target="_blank">#598</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] shortcodes: change <code>context</code> parameter to <code>page</code> if called as partial <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/595"target="_blank">#595</a></li>
<li>[<strong>feature</strong>] siteparam: support nested parameters and text formatting <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/590"target="_blank">#590</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] a11y: improve when tabbing thru links <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/581"target="_blank">#581</a></li>
<li>[<strong>bug</strong>] openapi: inherit RTL setting from Hugo content <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/600"target="_blank">#600</a></li>
<li>[<strong>bug</strong>] 404: fix display in RTL <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/597"target="_blank">#597</a></li>
<li>[<strong>bug</strong>] highlight: fix position of copy-to-clipboard button in RTL <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/594"target="_blank">#594</a></li>
<li>[<strong>bug</strong>] search: fix typo in output format <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/591"target="_blank">#591</a></li>
<li>[<strong>bug</strong>] tabs: fix tab selection by groupid <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/582"target="_blank">#582</a></li>
<li>[<strong>bug</strong>] theme: restore compat with Hugo 0.95.0 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/580"target="_blank">#580</a></li>
<li>[<strong>bug</strong>][<strong>change</strong>] theme: improve display of links <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/577"target="_blank">#577</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] highlight: make copy to clipboard appear on hover <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/574"target="_blank">#574</a></li>
<li>[<strong>bug</strong>] mermaid: allow for YAML frontmatter inside of graph <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/564"target="_blank">#564</a></li>
<li>[<strong>bug</strong>] alias: fix redirect URLs in case of empty BaseURL <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/562"target="_blank">#562</a></li>
<li>[<strong>feature</strong>] tabs: add title and icon option <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/552"target="_blank">#552</a></li>
<li>[<strong>feature</strong>] shortcodes: add style option to mimic code box color scheme <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/551"target="_blank">#551</a></li>
<li>[<strong>feature</strong>] tabs: support color options <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/550"target="_blank">#550</a></li>
<li>[<strong>feature</strong>] favicon: add light & dark option for OS’s prefered color scheme <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/549"target="_blank">#549</a></li>
<li>[<strong>bug</strong>] icon: remove whitespace on start <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/560"target="_blank">#560</a></li>
<li>[<strong>bug</strong>] shortcodes: avoid superflous margin at start and end of content <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/558"target="_blank">#558</a></li>
<li>[<strong>bug</strong>] expand: fix html encoding of finishing content tag <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/557"target="_blank">#557</a></li>
<li>[<strong>bug</strong>] icon: fix ouput “raw HTML omitted” with goldmark config unsafe=false <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/555"target="_blank">#555</a></li>
<li>[<strong>feature</strong>] taxonomy: add support for category default taxonomy <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/541"target="_blank">#541</a></li>
<li>[<strong>bug</strong>] attachments: work for Hugo < 0.112 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/546"target="_blank">#546</a></li>
<li>[<strong>bug</strong>] shortcodes: intermediately use random ids instead of .Ordinal <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/543"target="_blank">#543</a></li>
<li>[<strong>feature</strong>] tab: new shortcode to display single tab <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/538"target="_blank">#538</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] tabs: treat groupid as unique if not set <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/537"target="_blank">#537</a></li>
<li>[<strong>feature</strong>] notice: make boxes more prominent <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/535"target="_blank">#535</a></li>
<li>[<strong>bug</strong>] attachments: fix build error since Hugo 0.112 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/540"target="_blank">#540</a></li>
<li>[<strong>bug</strong>] tags: show taxonomy toc for standard installation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/533"target="_blank">#533</a></li>
<li>[<strong>bug</strong>] tags: translate breadcrumb and title for taxonomy <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/532"target="_blank">#532</a></li>
<li>[<strong>feature</strong>] tags: improve search index for tags <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/531"target="_blank">#531</a></li>
<li>[<strong>feature</strong>] tags: increase readability of taxonomy pages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/530"target="_blank">#530</a></li>
<li>[<strong>feature</strong>] nav: make breadcrumb separator configurable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/529"target="_blank">#529</a></li>
<li>[<strong>feature</strong>] i18n: add translation for default taxonomies <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/528"target="_blank">#528</a></li>
<li>[<strong>feature</strong>] theme: set appropriate defaults for all theme specific params <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/516"target="_blank">#516</a></li>
<li>[<strong>feature</strong>] theme: allow to display tags below article <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/513"target="_blank">#513</a></li>
<li>[<strong>bug</strong>] shortcode: make .context always a page <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/527"target="_blank">#527</a></li>
<li>[<strong>bug</strong>] print: enable print for pages with _build options <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/522"target="_blank">#522</a></li>
<li>[<strong>feature</strong>] theme: better HTML titles and breadcrumbs for search and tag pages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/521"target="_blank">#521</a></li>
<li>[<strong>bug</strong>] menu: avoid hiding of expander on hover when active item has children <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/520"target="_blank">#520</a></li>
<li>[<strong>bug</strong>] menu: showVisitedLinks not working for some theme variants <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/518"target="_blank">#518</a></li>
<li>[<strong>bug</strong>] theme: fix resource URLs for 404 page on subdirectories <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/515"target="_blank">#515</a></li>
<li>[<strong>bug</strong>] expand: not properly exanded when used in bullet point list <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/508"target="_blank">#508</a></li>
<li>[<strong>bug</strong>] theme: disableExplicitIndexURLs param is not working as expected <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/505"target="_blank">#505</a></li>
<li>[<strong>bug</strong>] attachments: fix links if only one language is present <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/503"target="_blank">#503</a></li>
<li>[<strong>bug</strong>] shortcodes: allow markdown for title and content <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/502"target="_blank">#502</a></li>
<li>[<strong>bug</strong>] menu: fix state for alwaysopen=false + collapsibleMenu=false <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/498"target="_blank">#498</a></li>
<li>[<strong>feature</strong>] frontmatter: support VSCode Front Matter extension <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/481"target="_blank">#481</a></li>
<li>[<strong>feature</strong>] theme: make expand and image ids stable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/477"target="_blank">#477</a></li>
<li>[<strong>feature</strong>] variant: set scrollbar color to dark for dark variants <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/471"target="_blank">#471</a></li>
<li>[<strong>feature</strong>] i18n: add full RTL support <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/470"target="_blank">#470</a></li>
<li>[<strong>feature</strong>] piratify: fix some quirks, arrr <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/469"target="_blank">#469</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: optimization for huge screen sizes <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/466"target="_blank">#466</a></li>
<li>[<strong>bug</strong>] i18n: write code ltr even for rtl languages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/492"target="_blank">#492</a></li>
<li>[<strong>bug</strong>] anchor: fix link in FF when served from filesystem <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/482"target="_blank">#482</a></li>
<li>[<strong>bug</strong>] shortcodes: don’t break build and render for invalid parameters <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/480"target="_blank">#480</a></li>
<li>[<strong>bug</strong>] nav: restore scroll position on browser back <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/476"target="_blank">#476</a></li>
<li>[<strong>bug</strong>] variant: avoid style leak for auto style <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/473"target="_blank">#473</a></li>
<li>[<strong>bug</strong>] tabs: nested tabs content is not displayed <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/468"target="_blank">#468</a></li>
<li>[<strong>bug</strong>] variant: include missing <code>theme-auto.css</code> in distribution <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/467"target="_blank">#467</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] lightbox: switch to CSS-only solution <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/451"target="_blank">#451</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] variant: add support for <code>prefers-color-scheme</code><ahref="https://github.com/McShelby/hugo-theme-relearn/issues/445"target="_blank">#445</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] expand: refactor for a11y <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/339"target="_blank">#339</a></li>
<li>[<strong>bug</strong>] swagger: avoid errors when using invalid rapi-doc fragment ids <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/465"target="_blank">#465</a></li>
<li>[<strong>bug</strong>] search: fix oddities in keyboard handling <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/463"target="_blank">#463</a></li>
<li>[<strong>bug</strong>] badge: fix text color for IE11 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/462"target="_blank">#462</a></li>
<li>[<strong>bug</strong>] mermaid: rerender graph if search term is present and variant is switched <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/460"target="_blank">#460</a></li>
<li>[<strong>bug</strong>] tags: show tag on pages when tag has space <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/459"target="_blank">#459</a></li>
<li>[<strong>bug</strong>] edit: remove double slash on root page link <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/450"target="_blank">#450</a></li>
<li>[<strong>task</strong>] build: check for release notes before release <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/448"target="_blank">#448</a></li>
<li>[<strong>feature</strong>] shortcodes: support for accent color <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/440"target="_blank">#440</a></li>
<li>[<strong>feature</strong>] shortcodes: add color parameter where applicable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/438"target="_blank">#438</a></li>
<li>[<strong>feature</strong>] theme: announce translations as alternate links <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/422"target="_blank">#422</a></li>
<li>[<strong>bug</strong>] variant: fix search icon and text color <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/437"target="_blank">#437</a></li>
<li>[<strong>bug</strong>][<strong>breaking</strong>] theme: allow pages on top level <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/434"target="_blank">#434</a></li>
<li>[<strong>task</strong>] build: switch to wildcard version of actions <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/428"target="_blank">#428</a></li>
<li>[<strong>bug</strong>] search: apply dependency scripts for Hindi and Japanese <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/427"target="_blank">#427</a></li>
<li>[<strong>feature</strong>] theme: make external link target configurable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/426"target="_blank">#426</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: open external links in separate tab <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/419"target="_blank">#419</a></li>
<li>[<strong>feature</strong>] theme: make it a Hugo module <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/417"target="_blank">#417</a></li>
<li>[<strong>bug</strong>] theme: fix alias for home page if defaultContentLanguageInSubdir=true <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/414"target="_blank">#414</a></li>
<li>[<strong>bug</strong>] theme: fix spacing for tag flyout in FF <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/413"target="_blank">#413</a></li>
<li>[<strong>bug</strong>] search: don’t freeze browser on long search terms <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/408"target="_blank">#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"target="_blank">#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"target="_blank">#404</a></li>
<li>[<strong>task</strong>] search: update lunr languages to 1.10.0 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/403"target="_blank">#403</a></li>
<li>[<strong>feature</strong>] search: make build and js forgiving against config errors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/400"target="_blank">#400</a></li>
<li>[<strong>bug</strong>] variant: minor color adjustments <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/402"target="_blank">#402</a></li>
<li>[<strong>bug</strong>] variant: fix generator for use of neon <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/401"target="_blank">#401</a></li>
<li>[<strong>bug</strong>] menu: relax usage of background color <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/399"target="_blank">#399</a></li>
<li>[<strong>bug</strong>] theme: make alias pages usable by file:// protocol <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/398"target="_blank">#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"target="_blank">#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"target="_blank">#383</a></li>
<li>[<strong>bug</strong>] mermaid: avoid leading whitespace <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/394"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#385</a></li>
<li>[<strong>bug</strong>] theme: add id to h1 elements <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/384"target="_blank">#384</a></li>
<li>[<strong>bug</strong>] rss: fix display of hidden subpages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/382"target="_blank">#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"target="_blank">#379</a></li>
<li>[<strong>task</strong>] mermaid: update to version 9.2.2 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/391"target="_blank">#391</a></li>
<li>[<strong>bug</strong>] tags: fix non-latin tag display on pages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/378"target="_blank">#378</a></li>
<li>[<strong>bug</strong>] theme: fix typo in 404.html <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/376"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#370</a></li>
<li>[<strong>task</strong>] build: change set-output to env vars <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/348"target="_blank">#348</a></li>
<li>[<strong>feature</strong>] math: allow passing of parameters with codefence syntax <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/363"target="_blank">#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"target="_blank">#360</a></li>
<li>[<strong>feature</strong>] i18n: support RTL <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/357"target="_blank">#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"target="_blank">#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"target="_blank">#349</a></li>
<li>[<strong>feature</strong>] expander: improve whitespace between label and content <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/338"target="_blank">#338</a></li>
<li>[<strong>feature</strong>] swagger: improve print version <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/333"target="_blank">#333</a></li>
<li>[<strong>bug</strong>] children: remove unused <code>page</code> parameter from docs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/336"target="_blank">#336</a></li>
<li>[<strong>bug</strong>] print: remove menu placeholder in Firefox <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/335"target="_blank">#335</a></li>
<li>[<strong>task</strong>] task: bump Hugo minimum requirement to 0.95 <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/319"target="_blank">#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"target="_blank">#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"target="_blank">#316</a></li>
<li>[<strong>bug</strong>] theme: fix chapter margins on big screens <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/315"target="_blank">#315</a></li>
<li>[<strong>bug</strong>] print: reset mermaid theme to light <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/313"target="_blank">#313</a></li>
<li>[<strong>bug</strong>] mermaid: header is showing up in FF <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/311"target="_blank">#311</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"target="_blank">#310</a></li>
<li>[<strong>bug</strong>] ie11: no styles after rework of archetypes <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/306"target="_blank">#306</a></li>
<li>[<strong>bug</strong>] theme: load CSS if JS is disabled <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/305"target="_blank">#305</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"target="_blank">#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"target="_blank">#299</a></li>
<li>[<strong>feature</strong>] menu: replace expander by fontawesome chevrons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/296"target="_blank">#296</a></li>
<li>[<strong>feature</strong>] theme: align content with topbar icon limits <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/290"target="_blank">#290</a></li>
<li>[<strong>feature</strong>] button: allow for empty href <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/288"target="_blank">#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"target="_blank">#287</a></li>
<li>[<strong>feature</strong>] clipboard: move head styles to stylesheet <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/286"target="_blank">#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"target="_blank">#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"target="_blank">#298</a></li>
<li>[<strong>bug</strong>] menu: make active expander visible on hover <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/297"target="_blank">#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"target="_blank">#292</a></li>
<li>[<strong>bug</strong>] theme: use more space on wide screens <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/291"target="_blank">#291</a></li>
<li>[<strong>bug</strong>] theme: fix size of chapter heading <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/289"target="_blank">#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"target="_blank">#285</a></li>
<li>[<strong>bug</strong>] children: descriptions not working <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/284"target="_blank">#284</a></li>
<li>[<strong>bug</strong>] print: fix empty page for shortcut links <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/283"target="_blank">#283</a></li>
<li>[<strong>bug</strong>] theme: fix url for logo and home button <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/282"target="_blank">#282</a></li>
<li>[<strong>bug</strong>][<strong>breaking</strong>] include: second parameter is ignored <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/281"target="_blank">#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"target="_blank">#279</a></li>
<li>[<strong>feature</strong>] shortcodes: convert to partials <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/277"target="_blank">#277</a></li>
<li>[<strong>bug</strong>] search: fix console message for missing lunr translations <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/278"target="_blank">#278</a></li>
<li>[<strong>bug</strong>] tabs: fix wrapping when having many tabs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/272"target="_blank">#272</a></li>
<li>[<strong>bug</strong>] notice: fix layout when content starts with heading <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/275"target="_blank">#275</a></li>
<li>[<strong>bug</strong>] i18n: Vietnamese language with wrong lang code <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/270"target="_blank">#270</a></li>
<li>[<strong>bug</strong>] i18n: fix search for non western languages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/269"target="_blank">#269</a></li>
<li>[<strong>bug</strong>] swagger: adjust font-size for method buttons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/267"target="_blank">#267</a></li>
<li>[<strong>bug</strong>] menu: hide expander when only hidden subpages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/264"target="_blank">#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"target="_blank">#263</a></li>
<li>[<strong>bug</strong>] theme: let browser scroll page on CTRL+f <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/242"target="_blank">#242</a></li>
<li>[<strong>feature</strong>] shortcodes: add named parameter if missing <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/260"target="_blank">#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"target="_blank">#256</a></li>
<li>[<strong>feature</strong>] i18n: add Italian translation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/254"target="_blank">#254</a></li>
<li>[<strong>feature</strong>] attachments: support for brand colors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/252"target="_blank">#252</a></li>
<li>[<strong>feature</strong>] notice: support for brand colors <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/251"target="_blank">#251</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"target="_blank">#246</a></li>
<li>[<strong>feature</strong>] variant: add support for brand color variables <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/239"target="_blank">#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"target="_blank">#261</a></li>
<li>[<strong>bug</strong>] print: adjust button and tab size <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/259"target="_blank">#259</a></li>
<li>[<strong>bug</strong>] print: show Mermaid if requested in frontmatter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/255"target="_blank">#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"target="_blank">#241</a></li>
<li>[<strong>feature</strong>] i18n: add Traditional Chinese translation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/233"target="_blank">#233</a></li>
<li>[<strong>feature</strong>] menu: expand/collapse menu items without navigation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/231"target="_blank">#231</a></li>
<li>[<strong>feature</strong>] print: add option to print whole chapter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/230"target="_blank">#230</a></li>
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: apply user supplied content footer below content <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/229"target="_blank">#229</a></li>
<li>[<strong>bug</strong>] theme: scroll to heading on initial load <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/232"target="_blank">#232</a></li>
<li>[<strong>feature</strong>] theme: add CSS font variables <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/227"target="_blank">#227</a></li>
<li>[<strong>feature</strong>] swagger: add support for oas/swagger documentation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/226"target="_blank">#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"target="_blank">#228</a></li>
<li>[<strong>bug</strong>] print: fix minor inconsistencies <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/225"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#219</a></li>
<li>[<strong>feature</strong>] mermaid: load javascript on demand <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/218"target="_blank">#218</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"target="_blank">#214</a></li>
<li>[<strong>bug</strong>] variant: switch breadcrumb color in Chrome <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/213"target="_blank">#213</a></li>
<li>[<strong>bug</strong>] mobile: improve behavior of sidebar menu <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/210"target="_blank">#210</a></li>
<li>[<strong>bug</strong>] variant: fix occasional fail when resetting generator <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/208"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#202</a></li>
<li>[<strong>feature</strong>] tags: show tag count in taxonomy list <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/195"target="_blank">#195</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"target="_blank">#197</a></li>
<li>[<strong>bug</strong>] tags: adhere to titleSeparator <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/196"target="_blank">#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"target="_blank">#194</a></li>
<li>[<strong>feature</strong>] children: set containerstyle automatically according to style <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/192"target="_blank">#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"target="_blank">#191</a></li>
<li>[<strong>feature</strong>] variant: build a variant generator <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/188"target="_blank">#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"target="_blank">#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"target="_blank">#181</a></li>
<li>[<strong>feature</strong>] variant: add a variant selector <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/178"target="_blank">#178</a></li>
<li>[<strong>feature</strong>] theme: support for dark mode <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/175"target="_blank">#175</a></li>
<li>[<strong>feature</strong>] docs: use light syntax highlightning theme <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/174"target="_blank">#174</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"target="_blank">#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"target="_blank">#176</a></li>
<li>[<strong>bug</strong>] exampleSite: fix links in official documentation <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/168"target="_blank">#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"target="_blank">#163</a></li>
<li>[<strong>feature</strong>] theme: add theme version info to head <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/158"target="_blank">#158</a></li>
<li>[<strong>bug</strong>] theme: fix selection of *.ico files as favicons <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/160"target="_blank">#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"target="_blank">#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"target="_blank">#155</a></li>
<li>[<strong>bug</strong>] menu: align long text properly <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/154"target="_blank">#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"target="_blank">#153</a></li>
<li>[<strong>bug</strong>] menu: show hidden sibling pages reliably <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/152"target="_blank">#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"target="_blank">#149</a></li>
<li>[<strong>bug</strong>] mermaid: let zoom reset to initial size <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/145"target="_blank">#145</a></li>
<li>[<strong>bug</strong>] mermaid: remove whitespace from big graphs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/143"target="_blank">#143</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"target="_blank">#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"target="_blank">#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"target="_blank">#133</a></li>
<li>[<strong>feature</strong>] mermaid: only load javascript if necessary <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/95"target="_blank">#95</a></li>
<li>[<strong>feature</strong>][<strong>change</strong>] theme: switch font <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/83"target="_blank">#83</a></li>
<li>[<strong>feature</strong>] theme: make favicon configurable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/2"target="_blank">#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"target="_blank">#136</a></li>
<li>[<strong>bug</strong>] menu: remove usage of Hugos UniqueID <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/131"target="_blank">#131</a></li>
<li>[<strong>bug</strong>] theme: reduce margin for children shortcode <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/130"target="_blank">#130</a></li>
<li>[<strong>bug</strong>] theme: left-align h3 in chapters <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/129"target="_blank">#129</a></li>
<li>[<strong>bug</strong>] theme: align copy link to clipboard <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/128"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#107</a></li>
<li>[<strong>feature</strong>] theme: announce alternative content in header <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/101"target="_blank">#101</a></li>
<li>[<strong>feature</strong>] menu: frontmatter option to change sort predicate <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/98"target="_blank">#98</a></li>
<li>[<strong>feature</strong>] menu: add default setting for menu expansion <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/97"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#90</a></li>
<li>[<strong>bug</strong>] theme: fix usage of section element <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/88"target="_blank">#88</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"target="_blank">#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"target="_blank">#86</a></li>
<li>[<strong>task</strong>] theme: switch from data-vocabulary to schema <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/84"target="_blank">#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"target="_blank">#80</a></li>
<li>[<strong>feature</strong>] menu: scroll active item into view <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/79"target="_blank">#79</a></li>
<li>[<strong>feature</strong>] search: disable search in hidden pages <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/76"target="_blank">#76</a></li>
<li>[<strong>feature</strong>] search: improve readablility of index.json <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/75"target="_blank">#75</a></li>
<li>[<strong>feature</strong>] menu: show hidden pages if accessed directly <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/60"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#56</a></li>
<li>[<strong>feature</strong>] theme: make chapter archetype more readable <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/55"target="_blank">#55</a></li>
<li>[<strong>feature</strong>] children: add parameter for container style <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/53"target="_blank">#53</a></li>
<li>[<strong>feature</strong>] theme: make content a template <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/50"target="_blank">#50</a></li>
<li>[<strong>feature</strong>] menu: control menu expansion with alwaysopen parameter <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/49"target="_blank">#49</a></li>
<li>[<strong>feature</strong>] include: new shortcode to include other files <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/43"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#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"target="_blank">#44</a></li>
<li>[<strong>task</strong>] docs: include changelog in exampleSite <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/33"target="_blank">#33</a></li>
<li>[<strong>feature</strong>] attachments: adjust style between notice boxes and attachments <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/28"target="_blank">#28</a></li>
<li>[<strong>feature</strong>] expand: add option to open on page load <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/25"target="_blank">#25</a></li>
<li>[<strong>feature</strong>] notice: make restyling of notice boxes more robust <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/20"target="_blank">#20</a></li>
<li>[<strong>feature</strong>] notice: align box colors to common standards <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/18"target="_blank">#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"target="_blank">#17</a></li>
<li>[<strong>bug</strong>] attachments: support i18n for attachment size <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/21"target="_blank">#21</a></li>
<li>[<strong>bug</strong>] notice: support i18n for box labels <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/16"target="_blank">#16</a></li>
<li>[<strong>bug</strong>] notice: support multiple blocks in one box <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/15"target="_blank">#15</a></li>
<li>[<strong>task</strong>] theme: prepare for new hugo theme registration <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/13"target="_blank">#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"target="_blank">#12</a></li>
<li>[<strong>bug</strong>] mermaid: only highlight text in HTML elements <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/10"target="_blank">#10</a></li>
<li>[<strong>bug</strong>] mermaid: support pan & zoom for graphs <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/9"target="_blank">#9</a></li>
<li>[<strong>bug</strong>] mermaid: code fences not always rendered <ahref="https://github.com/McShelby/hugo-theme-relearn/issues/6"target="_blank">#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"target="_blank">#5</a></li>
<p>In <strong>Hugo</strong>, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.</p>
<p>Organize your site like <ahref="https://gohugo.io/content/organization/"target="_blank">any other Hugo project</a>. Typically, you will have a <em>content</em> folder with all your pages.</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 to train by following <ahref="https://gohugo.io/overview/quickstart/"target="_blank">great documentation for beginners</a>.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new site <new_project></span></span></code></pre></div><p>The Relearn theme provides <ahref="./cont/archetypes/">archetypes</a> to help you create this kind of pages.</p>
<p>Each Hugo page has to define a <ahref="https://gohugo.io/content/front-matter/"target="_blank">frontmatter</a> in <em>toml</em>, <em>yaml</em> or <em>json</em>. This site will use <em>toml</em> in all cases.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Table of contents (toc) is enabled by default. Set this parameter to true to disable it.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Note: Toc is always disabled for chapter pages</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will be used for the page's menu entry (instead of the `title` attribute)</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, this will explicitly override common rules for the expand state of a page's menu entry</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># If set, this will explicitly override common rules for the sorting order of a page's submenu entries</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Display name of this page modifier. If set, it will be displayed in the footer.</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># Override default values for image effects, you can even add your own arbitrary effects to the list</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="err">+++</span></span></span></code></pre></div><h3id="add-icon-to-a-menu-entry">Add icon to a menu entry</h3>
<p>In the page frontmatter, add a <code>menuPre</code> param to insert any HTML code before the menu label. The example below uses the GitHub icon.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="err">+++</span></span></span></code></pre></div><h3id="using-a-custom-title-for-menu-entries">Using a custom title for menu entries</h3>
</span></span><spanclass="line"><spanclass="cl"><spanclass="err">+++</span></span></span></code></pre></div><h3id="override-expand-state-rules-for-menu-entries">Override expand state rules for menu entries</h3>
<p>You can change how the theme expands menu entries on the side of the content with the <code>alwaysopen</code> setting on a per page basis. If <code>alwaysopen=false</code> for any given entry, its children will not be shown in the menu as long as it is not necessary for the sake of navigation.</p>
<p>The theme generates the menu based on the following rules:</p>
<ul>
<li>all parent entries of the active page including their siblings are shown regardless of any settings</li>
<li>immediate children entries of the active page are shown regardless of any settings</li>
<li>if not overridden, all other first level entries behave like they would have been given <code>alwaysopen=false</code></li>
<li>if not overridden, all other entries of levels besides the first behave like they would have been given <code>alwaysopen=true</code></li>
<p>You may want to structure your pages in a hierachical way but don’t want to generate pages for those sections? The theme got you covered.</p>
<p>To stay with the initial example: Suppose you want <code>level-one</code> appear in the sidebar but don’t want to generate a page for it. So the entry in the sidebar should not be clickable but should show an expander.</p>
<p>For this, open <code>content/level-one/_index.md</code> and add the following frontmatter</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="nx">collapsibleMenu</span><spanclass="p">=</span><spanclass="kc">true</span><spanclass="c"># this adds the expander to the menu entry if not already set in your config.toml</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">render</span><spanclass="p">=</span><spanclass="s2">"never"</span><spanclass="c"># no page will be generated so the page does not have a url</span></span></span></code></pre></div>
<p>Using the command: <code>hugo new [relative new content path]</code>, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: <ahref="https://gohugo.io/content/archetypes/"target="_blank">archetypes</a>. These are preconfigured skeleton pages with default frontmatter.</p>
<p>The Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind home _index.md</span></span></code></pre></div><p>This leads to a file with the following content</p>
<p>A <strong>Chapter</strong> displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found below it.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind chapter <name>/_index.md</span></span></code></pre></div><p>This leads to a file with the following content</p>
</span></span><spanclass="line"><spanclass="cl">Lorem Ipsum.</span></span></code></pre></div><p>Replace the <code>X</code> with a number. Because this number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.</p>
<p>A <strong>Default</strong> page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new <chapter>/<name>/_index.md</span></span></code></pre></div><p>or</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new <chapter>/<name>.md</span></span></code></pre></div><p>This leads to a file with the following content</p>
</span></span><spanclass="line"><spanclass="cl">Lorem Ipsum.</span></span></code></pre></div><p>Replace the <code>X</code> with a number or delete the whole <code>weight</code> parameter entirely.</p>
<p>If you are in need of further archetypes you can define your own or even redefine existing ones.</p>
<h3id="template">Template</h3>
<p>Define a template file in your project at <code>archetypes/<kind>.md</code> and make sure it has at least the frontmatter parameter for that archetype like</p>
</span></span><spanclass="line"><spanclass="cl">+++</span></span></code></pre></div><p>Afterwards you can generate new content files of that kind with the following command</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-shell"data-lang="shell"><spanclass="line"><spanclass="cl">hugo new --kind <kind><name>/_index.md</span></span></code></pre></div><h3id="partials">Partials</h3>
<p>To define how your archetypes are rendered, define corresponding partial files in your projects directory <code>layouts/partials/archetypes/<kind></code>.</p>
<p>If you use an unknown archetype in your frontmatter, the <code>default</code> archetype will be used to generate the page.</p>
<p>Related to each archetype, several <em>hook</em> partial files in the form of <code><hook>.html</code> can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.</p>
<td>Defines a set of CSS classes to be added to the HTML’s <code><main></code> element. You can use these classes to define own CSS rules in your <code>custom-header.html</code></td>
<p>Each hook file can be overridden of a specific <ahref="https://gohugo.io/templates/output-formats/"target="_blank">output format</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/archetypes/default.plaintext.html</code> to change the way how normal content is written for that output format.</p>
<p>Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.</p>
<p><strong>Markdown</strong> is a better way to write <strong>HTML</strong>, without all the complexities and ugliness that usually accompanies it.</p>
<p>Some of the key benefits are:</p>
<ol>
<li>Markdown is simple to learn, with minimal extra characters so it’s also quicker to write content.</li>
<li>Less chance of errors when writing in Markdown.</li>
<li>Keeps the content and the visual display separate, so you cannot mess up the look of your site.</li>
<li>Write in any text editor or Markdown application you like.</li>
<li>Markdown is a joy to use!</li>
</ol>
<p>John Gruber, the author of Markdown, puts it like this:</p>
<blockquote>
<p>The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
<cite>John Gruber</cite></p>
</blockquote>
<p>Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:</p>
<p><iclass="fa-fw fas fa-bookmark"></i> Bookmark this page and the <ahref="https://commonmark.org/help/"target="_blank">official Commonmark reference</a> for easy future reference!</p>
<p>In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.</p>
<p>Any text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
</span></span><spanclass="line"><spanclass="cl">Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</span></span></code></pre></div>
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.</p>
<p>Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
<p>A good idea is to structure your content using headings and subheadings. HTML-headings from <code>h1</code> through <code>h6</code> are constructed with a <code>#</code> for each level.</p>
<p>In Hugo you usually don’t use <code>h1</code> as this is generated by your theme and you should only have one such element in a document.</p>
<p>To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes <code>---</code>.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
</span></span><spanclass="line"><spanclass="cl">Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</span></span></code></pre></div>
<p>Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">I am rendered with **bold text**</span></span></code></pre></div>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">I am rendered with _italicized text_</span></span></code></pre></div>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">~~Strike through this text~~</span></span></code></pre></div>
<p>This Markdown dialect supports an extension to combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">Double quotes <spanclass="sb">`"`</span> and single quotes <spanclass="sb">`'`</span> of enclosed text are replaced by <spanclass="ge">**</span>"double curly quotes"** and <spanclass="ge">**</span>'single curly quotes'**.
</span></span><spanclass="line"><spanclass="cl">Double dashes <spanclass="sb">`--`</span> and triple dashes <spanclass="sb">`---`</span> are replaced by en-dash <spanclass="ge">**</span>--** and em-dash <spanclass="ge">**</span>---** entities.
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl">Double arrows pointing left <spanclass="sb">`<<`</span> or right <spanclass="sb">`>>`</span> are replaced by arrow <spanclass="ge">**</span><spanclass="err"><<</span>** and <spanclass="ge">**</span>>>** entities.
</span></span><spanclass="line"><spanclass="cl">Three consecutive dots <spanclass="sb">`...`</span> are replaced by an ellipsis <spanclass="ge">**</span>...** entity.</span></span></code></pre></div>
<p>Double quotes <code>"</code> and single quotes <code>'</code> of enclosed text are replaced by <strong>“double curly quotes”</strong> and <strong>‘single curly quotes’</strong>.</p>
<p>Double dashes <code>--</code> and triple dashes <code>---</code> are replaced by en-dash <strong>–</strong> and em-dash <strong>—</strong> entities.</p>
<p>Double arrows pointing left <code><<</code> or right <code>>></code> are replaced by arrow <strong>«</strong> and <strong>»</strong> entities.</p>
<p>Three consecutive dots <code>...</code> are replaced by an ellipsis <strong>…</strong> entity.</p>
<p>You can write a list of items in which the order of the items does not explicitly matter.</p>
<p>It is possible to nest lists by indenting an item for the next sublevel.</p>
<p>You may use any of <code>-</code>, <code>*</code> or <code>+</code> to denote bullets for each list item but should not switch between those symbols inside one whole list.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">-</span> Lorem ipsum dolor sit amet
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">1.</span> Lorem ipsum dolor sit amet
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">- [x]</span> Basic Test
<p>This Markdown dialect supports an extension to add definition lists. Definition lists are made of terms and definitions of these terms, much like in a dictionary.</p>
<p>A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.</p>
<p>If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">In this example, <spanclass="sb">`<div></div>`</span> is marked as code.</span></span></code></pre></div>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">Be impressed by my advanced code:
<p>If you want to gain more control of your code block you can enclose your code by at least three backticks <code>```</code> a so called fence.</p>
<p>In GFM (GitHub Flavored Markdown) you can also add a language specifier directly after the opening fence, <code>```js</code>, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.</p>
<p>In GFM (GitHub Flavored Markdown) you can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl"><spanclass="k">></span><spanclass="ge">Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
</span></span></span><spanclass="line"><spanclass="cl"><spanclass="k"></span><spanclass="ge">>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
</span></span><spanclass="line"><spanclass="cl">> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</span></span></code></pre></div>
<p>Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.</p>
<blockquote>
<p>Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.</p>
</blockquote>
<p>Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">This is a link to https://example.com.</span></span></code></pre></div>
<p>Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.</p>
<p>Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.</p>
<p>Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.</p>
<p>Footnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-markdown"data-lang="markdown"><spanclass="line"><spanclass="cl">That's some text with a footnote[^1]
<p>Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.</p>
</span></span><spanclass="line"><spanclass="cl">[laforge]: https://octodex.github.com/images/trekkie.jpg "Geordi La Forge"</span></span></code></pre></div>
<p>This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default <ahref="./cont/imageeffects/">behavior is configurable</a> thru your <code>config.toml</code> or frontmatter parameter.</p>
<p>Add query parameter <code>width</code> and/or <code>height</code> to the link image to resize the image. Values are CSS values (default is <code>auto</code>).</p>
<p>Add a query parameter <code>classes</code> to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.</p>
<p>If you want to wrap an image in a link and <code>lightbox=true</code> is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your link like:</p>
<p>As you can see in the above example, the <code>bg-white</code> parameter is not initially supported in the themes default settings. Nevertheless you are free to define arbitrary parameter by just adding them to the URL query parameter or set them in your <code>config.toml</code> or pages frontmatter.</p>
<p>If no extended parameter like <code>bg-white</code> in the example is set on the URL, a <code>class="nobg-white"</code> in the HTML will only be generated if a default value was set in the <code>config.toml</code> or pages frontmatter.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">weight</span><spanclass="p">=</span><spanclass="mi">40</span></span></span></code></pre></div><p>By default, shortcuts are preceded by a title. This title can be disabled by setting <code>disableShortcutsTitle=true</code>.
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">other</span><spanclass="p">=</span><spanclass="s2">"<Your value>"</span></span></span></code></pre></div><p>Read more about <ahref="https://gohugo.io/extras/menus/"target="_blank">hugo menu</a> and <ahref="https://gohugo.io/content-management/multilingual/#translation-of-strings"target="_blank">hugo i18n translation strings</a></p>
<h2id="i18n">Configuration for Multilingual mode</h2>
<p>When using a multilingual website, you can set different menus for each language. In the <code>config.toml</code> file, prefix your menu configuration by <code>Languages.<language-id></code>.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s2">"Cap'n Hugo Relearrrn Theme"</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">weight</span><spanclass="p">=</span><spanclass="mi">40</span></span></span></code></pre></div><p>Read more about <ahref="https://gohugo.io/extras/menus/"target="_blank">hugo menu</a> and <ahref="https://gohugo.io/content-management/multilingual/#menus"target="_blank">hugo multilingual menus</a></p>
<p>Make the page file for the shortcut a <ahref="https://gohugo.io/content-management/age-bundles/#headless-bundle"target="_blank">headless branch bundle</a> (contained in its own subdirectory and called <code>_index.md</code>) and add the following frontmatter configuration to the file (see exampleSite’s <code>content/showcase/_index.en.md</code>). This causes its content to <strong>not</strong> be ontained in the sitemap.</p>
<p>Store the page file for the shortcut below a parent headless branch bundle and add the following frontmatter to he <strong>parent</strong> (see exampleSite’s <code>content/more/_index.en.md</code>).</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="c"># title = "More" ### ATTENTION: Don't give this page a title as this will cause it to be in the breadcrumbs - a thing you most likely don't want</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">publishResources</span><spanclass="p">=</span><spanclass="kc">false</span></span></span></code></pre></div><p>In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s <code>content/more/credits.en.md</code>). This causes its content to be contained in the sitemap.</p>
<p>After learning <ahref="https://gohugo.io/content-management/multilingual"target="_blank">how Hugo handle multilingual websites</a>, define your languages in your <code>config.toml</code> file.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-toml"data-lang="toml"><spanclass="line"><spanclass="cl"><spanclass="c"># English is the default language</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s2">"Cap'n Hugo Relearrrn Theme"</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">languageName</span><spanclass="p">=</span><spanclass="s2">"Arrr! Pirrrates"</span></span></span></code></pre></div><p>Then, for each new page, append the <em>id</em> of the language to the file.</p>
<p>In case each page’s content is written in one single language only, the above configuration will already configure the site’s search functionality correctly.</p>
<p>Although the theme supports a wide variety of supported languages, the site’s search via the <ahref="https://lunrjs.com"target="_blank">Lunr</a> search library does not.
<p>In case your page’s content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your <code>config.toml</code> to broaden search.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nx">additionalContentLanguage</span><spanclass="p">=</span><spanclass="p">[</span><spanclass="s2">"en"</span><spanclass="p">]</span></span></span></code></pre></div><p>As this is an array, you can add multiple additional languages.</p>
<p>Keep in mind that the language code required here, is the base language code. E.g. if you have additional content in <code>zh-CN</code>, you have to add just <code>zh</code> to this parameter.</p>
<p>Translations strings are used for common default values used in the theme (<em>Edit</em> button, <em>Search placeholder</em> and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.</p>
<p>To override these values, create a new file in your local i18n folder <code>i18n/<idlanguage>.toml</code> and inspire yourself from the theme <code>themes/hugo-theme-relearn/i18n/en.toml</code></p>
<h2id="disable-language-switching">Disable language switching</h2>
<p>Switching the language in the browser is a great feature, but for some reasons you may want to disable it.</p>
<p>Just set <code>disableLanguageSwitchingButton=true</code> in your <code>config.toml</code></p>
<p>The tags are displayed at the top of the page in alphabetical order.</p>
<p>The categories are displayed at the bottom of the page in alphabetical order in the default implementation of the theme but can be customized by providing your own <code>content-footer.html</code> partial.</p>
<p>Each item is a link to a taxonomy page displaying all the articles with the given term.</p>
<p>If you define <ahref="https://gohugo.io/content-management/taxonomies/#configure-taxonomies"target="_blank">custom taxonomies</a> and want to display a list of them somewhere on your page (often in the <code>layouts/partials/content-footer.html</code>) you can call a partial that does the job for you:</p>
<td>Additional CSS classes set on the outermost generated HTML element.<br><br>If set to <code>tags</code> you will get the visuals for displaying the <em>tags</em> taxonomy, otherwise it will be a simple list of links as for the <em>categories</em> taxonomy.</td>
</tr>
<tr>
<td><strong>style</strong></td>
<td><code>primary</code></td>
<td>The style scheme used if <strong>class</strong> is <code>tags</code>.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
</tr>
<tr>
<td><strong>color</strong></td>
<td>see notes</td>
<td>The <ahref="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value"target="_blank">CSS color value</a> to be used if <strong>class</strong> is <code>tags</code>. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
<p>Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.</p>
<p>But this happens to be a bad idea. Everyone uses Markdown because it’s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.</p>
<p>To avoid this limitations, Hugo created <ahref="https://gohugo.io/extras/shortcodes/"target="_blank">shortcodes</a>. A shortcode is a simple snippet inside a page.</p>
<p>Since Hugo <spanclass="badge cstyle default badge-with-title"><spanclass="badge-title"><iclass="fab fa-hackerrank"></i></span><spanclass="badge-content"style="background-color: fuchsia;">0.112.0</span></span> this only works for leaf bundles. Branch bundles and simple pages must be switched to leaf bundles or you are currently locked to a Hugo version <<code>0.112.0</code>.</p>
<td>The style scheme used for the box.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
<td>The <ahref="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value"target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
<td>Arbitrary text for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <code>Attachments</code><br><br>If you want no title for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<td><ahref="./shortcodes/icon/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <code>paperclip</code><br><br>If you want no icon, you have to set this parameter to <code>""</code> (a non empty d with spaces)</td>
<td>A <ahref="https://en.wikipedia.org/wiki/Regular_expression"target="_blank">regular expressions</a>, used to filter the attachments by file name. For example:<br><br>- to match a file suffix of ‘jpg’, use <code>.*\.jpg</code> (not <code>*.\.jpg</code>)<br>- to match file names ending in <code>jpg</code> or <code>png</code>, use <code>.*\.(jpg|png)</code></td>
<p>The shortcode lists files found in a specific folder. The name of the folder depends on your page type (either branch bundle, leaf bundle or page).</p>
<p>If your page is a branch bundle, attachments must be placed in a nested <code>_index.files</code> folder, accordingly.</p>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Warning</span></span> This is only available for Hugo <<code>0.112.0</code></p>
<p>For simple pages, attachments must be placed in a folder named like your page and ending with <code>.files</code>.</p>
<p><spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Warning</span></span> This is only available for Hugo <<code>0.112.0</code></p>
<p>Be aware that if you use a multilingual website, you will need to have as many folders as languages and the language code must be part of the folder name.</p>
<h3id="style-color-title-and-icons">Style, Color, Title and Icons</h3>
<p>For further examples for <strong>style</strong>, <strong>color</strong>, <strong>title</strong> and <strong>icon</strong>, see the <ahref="./shortcodes/notice/"><code>notice</code> shortcode</a> documentation. The parameter are working the same way for both shortcodes, besides having different defaults.</p>
<td>The style scheme used for the badge.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
<td>The <ahref="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value"target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
<td>Arbitrary text for the badge title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<td><ahref="./shortcodes/icon/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<h4id="with-user-defined-color-font-awesome-brand-icon-and-markdown-title-and-content">With User-Defined Color, Font Awesome Brand Icon and Markdown Title and Content</h4>
<p>In this case you need to declare <code>{{< badge >}}</code> instead of <code>{{% badge %}}</code>. Note, that in this case it is not possible to put markdown in the content.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="nx">Lorem</span><spanclass="nx">ipsum</span><spanclass="nx">dolor</span><spanclass="nx">sit</span><spanclass="nx">amet</span><spanclass="p">,</span><spanclass="nx">graecis</span><spanclass="nx">denique</span><spanclass="nx">ei</span><spanclass="nx">vel</span><spanclass="p">,</span><spanclass="nx">at</span><spanclass="nx">duo</span><spanclass="nx">primis</span><spanclass="nx">mandamus</span><spanclass="p">.</span><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">badge</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"blue"</span><spanclass="nx">icon</span><spanclass="p">=</span><spanclass="s">"rocket"</span><spanclass="o">%</span><spanclass="p">}}</span><spanclass="nx">Awesome</span><spanclass="p">{{</span><spanclass="o">%</span><spanclass="o">/</span><spanclass="nx">badge</span><spanclass="o">%</span><spanclass="p">}}</span><spanclass="nx">Et</span><spanclass="nx">legere</span><spanclass="nx">ocurreret</span><spanclass="nx">pri</span><spanclass="p">,</span><spanclass="nx">animal</span><spanclass="nx">tacimates</span><spanclass="nx">complectitur</span><spanclass="nx">ad</span><spanclass="nx">cum</span><spanclass="p">.</span><spanclass="nx">Cu</span><spanclass="nx">eum</span><spanclass="nx">inermis</span><spanclass="nx">inimicus</span><spanclass="nx">efficiendi</span><spanclass="p">.</span><spanclass="nx">Labore</span><spanclass="nx">officiis</span><spanclass="nx">his</span><spanclass="nx">ex</span><spanclass="p">,</span><spanclass="nx">soluta</span><spanclass="nx">officiis</span><spanclass="nx">concludaturque</span><spanclass="nx">ei</span><spanclass="nx">qui</span><spanclass="p">,</span><spanclass="nx">vide</span><spanclass="nx">sensibus</span><spanclass="nx">vim</span><spanclass="nx">ad</span><spanclass="p">.</span></span></span></code></pre></div><p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. <spanclass="badge cstyle blue badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-rocket"></i></span><spanclass="badge-content">Awesome</span></span> Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
<td>Either the destination URL for the button or JavaScript code to be executed on click. If this parameter is not set, the button will do nothing but is still displayed as clickable.<br><br>- if starting with <code>javascript:</code> all following text will be executed in your browser<br>- every other string will be interpreted as URL</td>
<td>The style scheme used for the button.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
<td>The <ahref="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value"target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
<td><ahref="./shortcodes/icon/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<td>The destination frame/window if <strong>href</strong> is an URL. Otherwise the parameter is not used. This behaves similar to normal links. If the parameter is not given it defaults to:<br><br>- the setting of <code>externalLinkTarget</code> or <code>_blank</code> if not set, for any address starting with <code>http://</code> or <code>https://</code><br>- no specific value for all other links</td>
<td>The <ahref="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type"target="_blank">button type</a> if <strong>href</strong> is JavaScript. Otherwise the parameter is not used. If the parameter is not given it defaults to <code>button</code></td>
<td>Arbitrary text for the button title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<td>When <code>true</code> shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - <ahref="https://gohugo.io/content/summaries/"target="_blank">read more info about summaries on gohugo.io</a>.</td>
<td>The depth of descendants to display. For example, if the value is <code>2</code>, the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. <code>999</code>.</td>
<td>The sort criteria of the displayed list.<br><br>- <code>auto</code> defaults to <ahref="./cont/pages/#frontmatter-configuration"><code>ordersectionsby</code> of the pages frontmatter</a><br>or to <ahref="./basics/configuration/#global-site-parameters"><code>ordersectionsby</code> of the site configuration</a><br>or to <code>weight</code><br>- <code>weight</code><br>- <code>title</code><br>- <code>linktitle</code><br>- <code>modifieddate</code><br>- <code>expirydate</code><br>- <code>publishdate</code><br>- <code>date</code><br>- <code>length</code><br>- <code>default</code> adhering to Hugo’s default sort criteria</td>
<p>This is a demo child page with a hidden child. You can still access the hidden child <ahref="./shortcodes/children/children-1/children-1-1/children-1-1-1/">directly</a> or via the search.</p>
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">expand</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"Show me almost **endless** possibilities"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code</span></span></code></pre></div><blockquote>
<p>This shortcode is fully compatible with Hugo’s <ahref="https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode"target="_blank"><code>highlight</code> shortcode</a> but <strong>offers some extensions</strong>.</p>
<p>It is called interchangeably in the same way as Hugo’s own shortcode providing positional parameter or by simply using codefences.</p>
<p>You are free to also call this shortcode from your own partials. In this case it resembles Hugo’s <ahref="https://gohugo.io/functions/highlight/"target="_blank"><code>highlight</code> function</a> syntax if you call this shortcode as a partial using compatiblity syntax.</p>
<p>While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports codefences (eg. GitHub) and so your markdown becomes more portable.</p>
<td>The language of the code to highlight. Choose from one of the <ahref="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages"target="_blank">supported languages</a>. Case-insensitive.</td>
<td><strong>Extension</strong>. Arbitrary title for code. This displays the code like a <ahref="./shortcodes/tab/">single tab</a> if <code>hl_inline=false</code> (which is Hugos default).</td>
<td><strong>Extension</strong>. When <code>true</code> the content may wrap on long lines otherwise it will be scrollable.<br><br>The default value can be set in your <code>config.toml</code> and overwritten via frontmatter. <ahref="#configuration">See below</a>.</td>
<td>An optional, comma-separated list of zero or more <ahref="https://gohugo.io/functions/highlight/#options"target="_blank">Hugo supported options</a> as well as extension parameter from this table.</td>
<p>Default values for <ahref="https://gohugo.io/functions/highlight/#options"target="_blank">Hugo’s supported options</a> can be set via <ahref="https://gohugo.io/getting-started/configuration-markup/#highlight"target="_blank">goldmark settings</a> in your <code>config.toml</code></p>
<p>Default values for extension options can be set via params settings in your <code>config.toml</code> or be overwritten by frontmatter for each individual page.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># the shipped variants come with their own modified chroma syntax highlightning</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># style which is imported in theme-relearn-light.css, theme-relearn-dark.css, etc.;</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># if you want to use a predefined style instead:</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - remove `noClasses` or set `noClasses = true`</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="c"># - set `style` to a predefined style name</span>
<p>As mentioned above, line numbers in a <code>table</code> layout will shift if code is wrapping, so better use <code>inline</code>. To make things easier for you, set <code>lineNumbersInTable = false</code> in your <code>config.toml</code> and add <code>lineNos = true</code> when calling the shortcode instead of the specific values <code>table</code> or <code>inline</code>.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p">{{<</span><spanclass="o">/</span><spanclass="nx">highlight</span><spanclass="p">>}}</span></span></span></code></pre></div><divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-py"data-lang="py"><spanclass="line"><spanclass="ln">666</span><spanclass="cl"><spanclass="c1"># the hardest part is to start writing code; here's a kickstart; just copy and paste this; it's free; the next lines will cost you serious credits</span>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-py"data-lang="py"><spanclass="line"><spanclass="cl"><spanclass="c1"># a bit shorter</span>
<p>Browse through the available icons in the <ahref="https://fontawesome.com/v5/search?m=free"target="_blank">Font Awesome Gallery</a>. Notice that the <strong>free</strong> filter is enabled, as only the free icons are available by default.</p>
<p>Once on the Font Awesome page for a specific icon, for example the page for the <ahref="https://fontawesome.com/v5/icons/heart?s=solid"target="_blank">heart</a>, copy the icon name and paste into the Markdown content.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="nx">Built</span><spanclass="nx">with</span><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">icon</span><spanclass="nx">heart</span><spanclass="o">%</span><spanclass="p">}}</span><spanclass="nx">by</span><spanclass="nx">Relearn</span><spanclass="nx">and</span><spanclass="nx">Hugo</span></span></span></code></pre></div><p>Built with <iclass="fa-fw fas fa-heart"></i> by Relearn and Hugo</p>
<p>While the shortcode simplifies using standard icons, the icon customization and other advanced features of the Font Awesome library require you to use HTML directly. Paste the <code><i></code> HTML into markup, and Font Awesome will load the relevant icon.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-html"data-lang="html"><spanclass="line"><spanclass="cl">Built with <spanclass="p"><</span><spanclass="nt">i</span><spanclass="na">class</span><spanclass="o">=</span><spanclass="s">"fas fa-heart"</span><spanclass="p">></</span><spanclass="nt">i</span><spanclass="p">></span> by Relearn and Hugo</span></span></code></pre></div><p>Built with <iclass="fas fa-heart"></i> by Relearn and Hugo</p>
<p>While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials.</p>
<td>The path to the file to be included. Path resolution adheres to <ahref="https://gohugo.io/functions/readfile/"target="_blank">Hugo’s build-in <code>readFile</code> function</a></td>
<td>When <code>true</code> and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files.</td>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">include</span><spanclass="s">"shortcodes/INCLUDE_ME.md"</span><spanclass="o">%</span><spanclass="p">}}</span></span></span></code></pre></div><p>You can add standard markdown syntax:</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code</span></span></code></pre></div><blockquote>
<p>the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)</p>
<p>Et Cetera (English: /ɛtˈsɛtərə/), abbreviated to etc., etc, et cet., is a Latin expression that is used in English to mean “and other similar things”, or “and so forth” <ahref="#fnref:1"class="footnote-backref"role="doc-backlink">↩︎</a></p>
<p>The <code>math</code> shortcode generates beautiful formatted math and chemical formulae using the <ahref="https://mathjax.org/"target="_blank">MathJax</a> library.</p>
<p>While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable.</p>
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting (<ahref="#configuration">see the configuration section</a>).</p>
<p>MathJax is configured with default settings. You can customize MathJax’s default settings for all of your files thru a JSON object in your <code>config.toml</code> or override these settings per page thru your pages frontmatter.</p>
<p>The JSON object of your <code>config.toml</code> / frontmatter is forwarded into MathJax’s configuration object.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">Inline math is generated if you use a single <spanclass="sb">`$`</span> as a delimiter around your formulae: {{<spanclass="p"><</span><spanclass="nt">math</span><spanclass="p">></span>}}$\sqrt{3}${{<spanclass="p"><</span><spanclass="p">/</span><spanclass="nt">math</span><spanclass="p">></span>}}</span></span></code></pre></div><p>Inline math is generated if you use a single <code>$</code> as a delimiter around your formulae:
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-md"data-lang="md"><spanclass="line"><spanclass="cl">If you delimit your formulae by two consecutive <spanclass="sb">`$$`</span> it generates a new block.
</span></span><spanclass="line"><spanclass="cl">{{<spanclass="p"><</span><spanclass="p">/</span><spanclass="nt">math</span><spanclass="p">></span>}}</span></span></code></pre></div><p>If you delimit your formulae by two consecutive <code>$$</code> it generates a new block.</p>
<p>The <code>mermaid</code> shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the <ahref="https://mermaidjs.github.io/"target="_blank">Mermaid</a> library.</p>
<p>While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Mermaid codefences (eg. GitHub) and so your markdown becomes more portable.</p>
<p>You are free to also call this shortcode from your own partials.</p>
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting (<ahref="#configuration">see the configuration section</a>).</p>
<td>Whether the graph is pan- and zoomable.<br><br>If not set the value is determined by the <code>mermaidZoom</code> setting of the <ahref="#global-configuration-file">site</a> or the <ahref="#pages-frontmatter">pages frontmatter</a> or <code>false</code> if not set at all.<br><br>- <code>false</code>: no pan or zoom<br>- <code>true</code>: pan and zoom active</td>
<p>Mermaid is configured with default settings. You can customize Mermaid’s default settings for all of your files thru a JSON object in your <code>config.toml</code>, override these settings per page thru your pages frontmatter or override these setting per diagramm thru <ahref="https://mermaid-js.github.io/mermaid/#/directives?id=directives"target="_blank">diagram directives</a>.</p>
<p>See <ahref="https://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults"target="_blank">Mermaid documentation</a> for all allowed settings.</p>
<p>The <code>theme</code> setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in <code>config.toml</code>, frontmatter or diagram directives.</p>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">Person</span><spanclass="p">(</span><spanclass="nx">customerA</span><spanclass="p">,</span><spanclass="s">"Banking Customer A"</span><spanclass="p">,</span><spanclass="s">"A customer of the bank, with personal bank accounts."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">Person</span><spanclass="p">(</span><spanclass="nx">customerD</span><spanclass="p">,</span><spanclass="s">"Banking Customer D"</span><spanclass="p">,</span><spanclass="s">"A customer of the bank, <br/> with personal bank accounts."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl">
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">System</span><spanclass="p">(</span><spanclass="nx">SystemAA</span><spanclass="p">,</span><spanclass="s">"Internet Banking System"</span><spanclass="p">,</span><spanclass="s">"Allows customers to view information about their bank accounts, and make payments."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">SystemDb_Ext</span><spanclass="p">(</span><spanclass="nx">SystemE</span><spanclass="p">,</span><spanclass="s">"Mainframe Banking System"</span><spanclass="p">,</span><spanclass="s">"Stores all of the core banking information about customers, accounts, transactions, etc."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">System</span><spanclass="p">(</span><spanclass="nx">SystemA</span><spanclass="p">,</span><spanclass="s">"Banking System A"</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">System</span><spanclass="p">(</span><spanclass="nx">SystemB</span><spanclass="p">,</span><spanclass="s">"Banking System B"</span><spanclass="p">,</span><spanclass="s">"A system of the bank, with personal bank accounts. next line."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">System_Ext</span><spanclass="p">(</span><spanclass="nx">SystemC</span><spanclass="p">,</span><spanclass="s">"E-mail system"</span><spanclass="p">,</span><spanclass="s">"The internal Microsoft Exchange e-mail system."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">SystemDb</span><spanclass="p">(</span><spanclass="nx">SystemD</span><spanclass="p">,</span><spanclass="s">"Banking System D Database"</span><spanclass="p">,</span><spanclass="s">"A system of the bank, with personal bank accounts."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">SystemQueue</span><spanclass="p">(</span><spanclass="nx">SystemF</span><spanclass="p">,</span><spanclass="s">"Banking System F Queue"</span><spanclass="p">,</span><spanclass="s">"A system of the bank."</span><spanclass="p">)</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="nf">SystemQueue_Ext</span><spanclass="p">(</span><spanclass="nx">SystemG</span><spanclass="p">,</span><spanclass="s">"Banking System G Queue"</span><spanclass="p">,</span><spanclass="s">"A system of the bank, with personal bank accounts."</span><spanclass="p">)</span>
Person(customerD, "Banking Customer D", "A customer of the bank, <br/> with personal bank accounts.")
System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")
Enterprise_Boundary(b1, "BankBoundary") {
SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")
System_Boundary(b2, "BankBoundary2") {
System(SystemA, "Banking System A")
System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts. next line.")
}
System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.</p>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"primary"</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"There may be pirates"</span><spanclass="nx">icon</span><spanclass="p">=</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">primary</span><spanclass="s">"There may be pirates"</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<td>The style scheme used for the box.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
<td>The <ahref="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value"target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
<td>Arbitrary text for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<td><ahref="./shortcodes/icon/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-plaintext"data-lang="plaintext"><spanclass="line"><spanclass="cl">...and even source code</span></span></code></pre></div><blockquote>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"warning"</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"Here are dragons"</span><spanclass="nx">icon</span><spanclass="p">=</span><spanclass="s">"dragon"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="k">default</span><spanclass="s">"Pay Attention to this Note!"</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<divclass="wrap-code highlight"><pretabindex="0"class="chroma"><codeclass="language-go"data-lang="go"><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">notice</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"transparent"</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"Pay Attention to this Note!"</span><spanclass="nx">icon</span><spanclass="p">=</span><spanclass="s">"skull-crossbones"</span><spanclass="o">%</span><spanclass="p">}}</span>
<p>The <code>openapi</code> shortcode uses the <ahref="https://github.com/swagger-api/swagger-ui"target="_blank">Swagger UI</a> library to display your OpenAPI / Swagger specifications.</p>
<p>If you want to print out (or generate a PDF) from your OpenAPI documentation, don’t initiate printing directly from the page because the elements are optimized for interactive usage in a browser.</p>
<p>Instead, open the <ahref="./basics/configuration/#activate-print-support">print preview</a> in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.</p>
<p>While the examples are using shortcodes with named parameter you are free to use positional aswell or call this shortcode from your own partials.</p>
<td>The style scheme used for the tab. If you don’t set a style and you display a single code block inside of the tab, its default styling will adapt to that of a <code>code</code> block. Otherwise <code>default</code> is used.<br><br>- by severity: <code>info</code>, <code>note</code>, <code>tip</code>, <code>warning</code><br>- by brand color: <code>primary</code>, <code>secondary</code>, <code>accent</code><br>- by color: <code>blue</code>, <code>green</code>, <code>grey</code>, <code>orange</code>, <code>red</code><br>- by special color: <code>default</code>, <code>transparent</code>, <code>code</code></td>
<td>The <ahref="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value"target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
<td>Arbitrary title for the tab. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
<td><ahref="./shortcodes/icon/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>""</code> (a non empty string filled with spaces)</td>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">tab</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"default style and color"</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"default"</span><spanclass="nx">color</span><spanclass="p">=</span><spanclass="s">"blue"</span><spanclass="o">%</span><spanclass="p">}}</span>
</span></span><spanclass="line"><spanclass="cl"><spanclass="p">{{</span><spanclass="o">%</span><spanclass="nx">tab</span><spanclass="nx">title</span><spanclass="p">=</span><spanclass="s">"severity style and color"</span><spanclass="nx">style</span><spanclass="p">=</span><spanclass="s">"info"</span><spanclass="nx">color</span><spanclass="p">=</span><spanclass="s">"blue"</span><spanclass="o">%</span><spanclass="p">}}</span>
<p>The <code>style</code> parameter affects how the <code>color</code> parameter is applied.</p>
<p>The <code>default</code> style will set the background to your <code>--MAIN-BG-color</code> as configured for your theme variant resembling the default style but with different color.</p>
<p>The <code>style</code> parameter is set to a severity style.</p>
<p>This will set the background to a lighter version of the chosen style color as configured in your theme variant and also affects the chosen icon.</p>
<td>Arbitrary name of the group the tab view belongs to.<br><br>Tab views with the same <strong>groupid</strong> sychronize their selected tab. The tab selection is restored automatically based on the <code>groupid</code> for tab view. If the selected tab can not be found in a tab group the first tab is selected instead.<br><br>This sychronization applies to the whole site!</td>
<td>Sets a default value for every contained tab. Can be overridden by each tab. See the <ahref="./shortcodes/tab/#parameter"><code>tab</code> shortcode</a> for possible values.</td>
<td>Sets a default value for every contained tab. Can be overridden by each tab. See the <ahref="./shortcodes/tab/#parameter"><code>tab</code> shortcode</a> for possible values.</td>
<h3id="nested-tab-views-and-color">Nested Tab Views and Color</h3>
<p>In case you want to nest tab views, the parent tab that contains nested tab views needs to be declared with <code>{{< tab >}}</code> instead of <code>{{% tab %}}</code>. Note, that in this case it is not possible to put markdown in the parent tab.</p>
<p>You can also set style and color parameter for all tabs and overwrite them on tab level. See the <ahref="./shortcodes/tab/#parameter"><code>tab</code> shortcode</a> for possible values.</p>
