# Basics :: Hugo Relearn Theme
Documentation for Hugo Relearn Theme
Author: Sören Weber

Chapter 1

# Basics

Discover what this Hugo theme is all about and the core-concepts behind it.

# Subsections of Basics

# What's New

This document shows you what’s new in the latest release. For a detailed list of changes, see the history page.

0.95.0 The minimum required Hugo version.

Breaking A change that requires action by you after upgrading to assure the site is still functional.

Change A change in default behavior that may requires action by you if you want to revert it.

New Marks new behavior you might find interesting or comes configurable.

## 5.11.0 (2023-02-06)

- Change The theme removed the popular jQuery library from its distribution.

  In case you made changes to the theme that are dependend on this library you can place a copy of jQuery into your `static/js` directory and load it from your own `layouts/partials/custom-header.html` like this:

      <script src="{{"js/jquery.min.js"| relURL}}{{ if $assetBusting }}?{{ now.Unix }}{{ end }}" defer></script>

- Change Mermaid diagrams can now be configured for pan and zoom on site-, page-level or individually for each graph.

  The default setting of `on`, in effect since 1.1.0, changed back to `off` as there was interference with scrolling on mobile and big pages.

- Change The theme is now capable to visually adapt to your OS’s light/dark mode setting.

  This is also the new default setting if you haven’t configured `themeVariant` in your `config.toml`.

  Additionally you can configure the variants to be taken for light/dark mode with the new `themeVariantAuto` parameter.

  This is not supported for Internet Explorer 11, which still displays in the `relearn-light` variant.

- Change The JavaScript code for handling image lightboxes (provided by Featherlight) was replaced by a CSS-only solution.

  This also changed the lightbox effects parameter from `featherlight=false` to `lightbox=false`. Nevertheless you don’t need to change anything as the old name will be used as a fallback.

- Change In the effort to comply with WCAG standards, the implementation of the `expand` shortcode was changed. While Internet Explorer 11 has issues in displaying it, the functionality still works.

- New Translation for Czech. This language is not supported for search.

- New GitHub releases are also now tagged for the main version (eg. `1.2.x`), major version (eg. `1.x`) and the latest (just `x`) release making it easier for you to pin the theme to a certain version.

## 5.10.0 (2023-01-25)

- New The `attachments`, `badge`, `button` and `notice` shortcodes have a new parameter `color` to set arbitrary CSS color values.

  Additionally the `--ACCENT-color` brand color introduced in version 5.8.0 is now supported with these shortcodes.

## 5.9.0 (2022-12-23)

- Change The required folder name for the `attachments` shortcode was changed for leaf bundles.

  Previously, the attachments for leaf bundles in non-multilang setups were required to be in a `files` subdirectory. For page bundles and leaf bundles in multilang setups they were always required to be in a `_index.<LANGCODE>.files` or `index.<LANGCODE>.files` subdirectory accordingly.

  This added unnessessary complexity. So attachments for leaf bundles in non-multilang setups can now also reside in a `index.files` directory. Although the old `files` directory is now deprecated, if both directories are present, only the old `files` directory will be used for compatiblity.

- Change Absolute links prefixed with `http://` or `https://` are now opened in a separate browser tab.

  You can revert back to the old behavior by defining `externalLinkTarget="_self"` in the `params` section of your `config.toml`.

- New The theme now supports Hugo’s module system.

## 5.8.0 (2022-12-08)

- New The new `badge` shortcode is now available to add highly configurable markers to your content as you can see it on this page.

- New The new `icon` shortcode simplyfies the usage of icons. This can even be combined with also new `badge` shortcode.

- New The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely task lists, defintion lists and footnotes.

- New A new color `--ACCENT-color` 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 `yellow` color is still used as default.

## 5.7.0 (2022-11-29)

- Change The Korean language translation for this theme is now available with the language code `ko`. Formerly the country code `kr` was used instead.

- New The `button` shortcode 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.

- New The search now supports the Korean language.

## 5.6.0 (2022-11-18)

- New 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.

  To activate this feature, you need to configure it in your `config.toml` as a new outputformat `SEARCHPAGE` for the home page. If you don’t configure it, no dedicated search page will be accessible and the theme works as before.

  You can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.

- New Keyboard handling for the TOC and search was improved.

  Pressing `CTRL+ALT+t` 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 `TAB` key.

  The search received its own brand new keyboard shortcut `CTRL+ALT+f`. This will focus the cursor inside of the the search box so you can immediately start your search by typing.

- New 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.

  To configure this in your `config.toml` make sure to set Hugo’s `disableHugoGeneratorInject=true` and also `[params] disableGeneratorVersion=true`, otherwise Hugo will generate a meta tag into your home page automagically.

- New Creation of your project gets a little bit faster with this release.

  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.).

## 5.5.0 (2022-11-06)

- Change 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.

  For that the JavaScript code to handle the lightbox and image effects on the client side was removed in favour for static generation of those effects on the server.

  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 `img` URLs manually to the respective HTML attributes.

  Old | New
  --- | ---
  `<img src="pic.png?width=20vw&classes=shadow,border">` | `<img src="pic.png" style="width:20vw;" class="shadow border">`

## 5.4.0 (2022-11-01)

- Change With the proper settings in your `config.toml` your page is now servable from the local file system using `file://` URLs.

  Please note that the searchbox will only work for this if you reconfigure your outputformat for the homepage in your `config.toml` from `JSON` to `SEARCH`. The now deprecated `JSON` outputformat still works as before, so there is no need to reconfigure your installation if it is only served from `http://` or `https://`.

- Change The `button` shortcode has a new parameter `target` 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.

- New The `math` shortcode and `mermaid` shortcode now also support the `align` parameter if codefence syntax is used.

- New 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.

- New Translation for Finnish (Suomi).

## 5.3.0 (2022-10-07)

- Change 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).

- New Image formatting has two new classes to align images to the `left` or `right`. Additionally, the already existing `inline` option is now documented.

- New Printing for the `swagger` shortcode was optimized to expand sections that are usually closed in interactive mode. This requires print support to be configured.

## 5.2.0 (2022-08-03)

- Change If you’ve set `collapsibleMenu = true` in your `config.toml`, 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.

## 5.1.0 (2022-07-15)

- 0.95.0 This release requires a newer Hugo version.

- Change 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 `index.print.html` to the default URL.

  You can revert this behavior by overwriting the PRINT output format setting in your `config.toml`to:

      [outputFormats]
        [outputFormats.PRINT]
          name= "PRINT"
          baseName = "index"
          path = "_print"
          isHTML = true
          mediaType = 'text/html'
          permalinkable = false

## 5.0.0 (2022-07-05)

- Breaking 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 `*.js` file (if not already) and add the `defer` keyword to the `script` element. Eg.

      <script defer src="myscript.js"></script>

- Change The way archetypes are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones.

  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:

  - for your home page, add the frontmatter parameter `archetype = "home"` and remove the leading heading

  - for all files containing the deprecated frontmatter parameter `chapter = true`, replace it with `archetype = "chapter"` and remove the leading headings

- Change The frontmatter options `pre` / `post` were renamed to `menuPre` / `menuPost`. 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.

- New Adding new partials `heading-pre.html` / `heading-post.html` and according frontmatter options `headingPre` / `headingPost` to modify the way your page`s main heading gets styled.

- New The new shortcode `math` is available to add beautiful math and chemical formulae. See the documentation for available features. This feature will not work with Internet Explorer 11.

## 4.2.0 (2022-06-23)

- Breaking The second parameter for the `include` shortcode was switched in meaning and was renamed from `showfirstheading` to `hidefirstheading`. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.

  If you’ve used the second boolean parameter, you have to rename it and invert its value to achieve the same behavior.

- Change Previously, if the `tabs` shortcode could not find a tab item because, the tabs ended up empty. Now the first tab is selected instead.

- Change The `landingPageURL` was removed from `config.toml`. 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.

- New All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.

## 4.1.0 (2022-06-12)

- New While fixing issues with the search functionality for non Latin languages, you can now configure to have multiple languages on a single page.

## 4.0.0 (2022-06-05)

- Breaking The `custom_css` config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the `custom-header.html` template in a much more generic manner.

- Breaking Because anchor hover color was not configurable without introducing more complexity to the variant stylesheets, we decided to remove `--MAIN-ANCHOR-color` instead. You don’t need to change anything in your custom color stylesheet as the anchors now get their colors from `--MAIN-LINK-color` and `--MAIN-ANCHOR-HOVER-color` respectively.

- New 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.

  This applies to `expand`, `include`, `notice` and `siteparam`.

- New The `button` shortcode received some love and now has a parameter for the color style similar to other shortcodes.

- New New colors `--PRIMARY-color` and `--SECONDARY-color` were added to provide easier modification of your custom style. Shortcodes with a color style can now have `primary` or `secondary` as additional values.

  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.

- New Translation for Polish. This language is not supported for search.

- New The documentation for all shortcodes were revised.

## 3.4.0 (2022-04-03)

- Breaking If you had previously overwritten the `custom-footer.html` partial to add visual elements below the content of your page, you have to move this content to the new partial `content-footer.html`. `custom-footer.html` was never meant to contain HTML other than additional styles and JavaScript.

- New If you prefer expandable/collapsible menu items, you can now set `collapsibleMenu=true` in your `config.toml`. 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.

- New You can activate print support in your `config.toml` to add the capability to print whole chapters or even the complete site.

- New Translation for Traditional Chinese.

## 3.3.0 (2022-03-28)

- New Introduction of new CSS variables to set the font. The theme distinguishes between `--MAIN-font` for all content text and `--CODE-font` for inline or block code. There are additional overrides for all headings. See the theme variant generator of the exampleSite for all available variables.

- New The new shortcode `swagger` is available to include a UI for REST OpenAPI Specifications. See the documentation for available features. This feature will not work with Internet Explorer 11.

## 3.2.0 (2022-03-19)

- 0.93.0 This release requires a newer Hugo version.

- Change 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 `disableMermaid` config option as follows: If a Mermaid shortcode or codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.

  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 `disableMermaid=false` in your frontmatter to force the library to be loaded. See the theme variant generator of the exampleSite for an example.

- New Additional color variant variable `--MERMAID-theme` 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.

## 3.1.0 (2022-03-15)

- New `attachment` and `notice` shortcodes have a new parameter to override the default icon. Allowed values are all Font Awesome 5 Free icons.

## 3.0.0 (2022-02-22)

- Breaking We made changes to the menu footer. If you have your `menu-footer.html` partial overridden, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the `menu-footer.html` partial that is coming with the exampleSite.

  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 Clear history functionality).

- Breaking 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.

  This change will only affect your installation if you’ve not set the `themeVariant` parameter in your `config.toml`. If you still want to use the Learn color variant, you have to explicitly set `themeVariant="learn"` in your `config.toml`.

  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.

- Change Due to a bug, that we couldn’t fix in a general manner for color variants, we decided to remove `--MENU-SEARCH-BOX-ICONS-color` and introduced `--MENU-SEARCH-color` instead. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.

- Change For consistency reasons, we renamed `--MENU-SEARCH-BOX-color` to `--MENU-SEARCH-BORDER-color`. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.

- New With this release you are now capable to define your own dark mode variants.

  To make this possible, we have introduced a lot more color variables you can use in your color variants. 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.

  To see what’s now possible, see the new variants `relearn-dark` and `neon` that are coming with this release.

- New To make the creation of new variants easier for you, we’ve added a new interactive theme variant generator. This feature will not work with Internet Explorer 11.

- New You can now configure multiple color variants in your `config.toml`. 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 documentation for configuration.

  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.

## 2.9.0 (2021-11-19)

- Breaking This release removes the themes implementation of `ref`/`relref` 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.

  In a standard compliant form you must not link to the `*.md` file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:

  Type | Non-Standard | Standard
  --- | --- | ---
  Branch bundle | `basics/configuration/_index.md` | `basics/configuration`
  Leaf bundle | `basics/configuration/index.md` | `basics/configuration`
  Page | `basics/configuration.md` | `basics/configuration`

  If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but Hugo got you covered as well.

  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 reconfigure the error handling of Hugos implementation.

  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 `hugo server` after an upgrade and no errors are written to the console.

  You may see errors on the console after the update in the form:

      ERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref "basics/configuration/_index.md": "hugo-theme-relearn\exampleSite\content\_index.en.md:19:22": page not found

  In this case, you must apply one of two options:

  1. Copy the old implementation files `theme/hugo-theme-relearn/layouts/shortcode/ref.html` and `theme/hugo-theme-relearn/layouts/shortcode/relref.html` to your own projects `layouts/shortcode/ref.html` and `layouts/shortcode/relref.html` respectively. This is not recommended as your project will still rely on non-standard behavior afterwards.

  2. Start up a text editor with regular expression support for search and replace. Apply the following conversions in the given order on all `*.md` files. This is the recommended choice.

  Type | Search | Replace by
  --- | --- | ---
  Branch bundle | `(ref\s+"[^"]*)/_index\.md"` | `$1"`
  Leaf bundle | `(ref\s+"[^"]*)/index\.md"` | `$1"`
  Page | `(ref\s+"[^"]*)\.md"` | `$1"`

## 2.8.0 (2021-11-03)

- Change Although never officially documented, this release removes the font `Novacento`/`Novecento`. If you use it in an overwritten CSS please replace it with `Work Sans`. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for Czech.

- New The theme now supports favicons served from `static/images/` named as `favicon` or `logo` in SVG, PNG or ICO format out of the box. An overridden partial `layouts/partials/favicon.html` may not be necessary anymore in most cases.

- New You can hide the table of contents menu for the whole site by setting the `disableToc` option in your `config.toml`. For an example see the example configuration.

## 2.7.0 (2021-10-24)

- New Optional second parameter for `notice` shortcode to set title in box header.

## 2.6.0 (2021-10-21)

- New Your site can now be served from a subfolder if you set `baseURL` and `canonifyURLs=true` in your `config.toml`. See the documentation for a detailed example.

## 2.5.0 (2021-10-08)

- Change New colors `--CODE-BLOCK-color` and `--CODE-BLOCK-BG-color` were added to provide a fallback for Hugos syntax highlighting in case `guessSyntax=true` is set. Ideally the colors are set to the same values as the ones from your chosen chroma style.

## 2.4.0 (2021-10-07)

- Change 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.

- New Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting `disableTagHiddenPages=true` in your `config.toml`.

- New You can define the expansion state of your menus for the whole site by setting the `alwaysopen` option in your `config.toml`. Please see further documentation for possible values and default behavior.

- New New frontmatter `ordersectionsby` option to change immediate children sorting in menu and `children` shortcode. Possible values are `title` or `weight`.

- New Alternate content of a page is now advertised in the HTML meta tags. See Hugo documentation.

## 2.3.0 (2021-09-13)

- 0.81.0 This release requires a newer Hugo version.

- New 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.

## 2.2.0 (2021-09-09)

- New 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 `disableSeoHiddenPages=true` in your `config.toml`.

## 2.1.0 (2021-09-07)

- 0.69.0 This release requires a newer Hugo version.

- Change 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 `CHANGELOG.md` in the exampleSite), they will now be ignored by the search.

- New Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting `disableSearchHiddenPages=true` in your `config.toml`.

- New If a search term is found in an `expand` shortcode, the expand will be opened.

- New The menu will scroll the active item into view on load.

## 2.0.0 (2021-08-28)

- Change Syntax highlighting was switched to the built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation

- Change In the predefined stylesheets there was a typo and `--MENU-HOME-LINK-HOVERED-color` must be changed to `--MENU-HOME-LINK-HOVER-color`. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.

- Change `--MENU-HOME-LINK-color` and `--MENU-HOME-LINK-HOVER-color` were missing in the documentation. You should add them to your custom stylesheets if you want to override the defaults.

- Change Arrow navigation and `children` shortcode were ignoring setting for `ordersectionsby`. This is now changed and may result in different sorting order of your sub pages.

- Change If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.

- Change A page without a `title` will be treated as `hidden=true`.

- New You can define the expansion state of your menus in the frontmatter. Please see further documentation for possible values and default behavior.

- New New partials for defining pre/post content for menu items and the content. See documentation for further reading.

- New Shortcode `children` with new parameter `containerstyle`.

- New New shortcode `include` to include arbitrary file content into a page.

## 1.2.0 (2021-07-26)

- New Shortcode `expand` with new parameter to open on page load.

## 1.1.0 (2021-07-02)

- Breaking Mermaid diagrams can now be panned and zoomed. This isn’t configurable yet.

- New `Mermaid` config options can be set in `config.toml`.

## 1.0.0 (2021-07-01)

- 0.65.0 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.

- New Initial fork of the Learn theme based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to `Relearn` and a new logo. For the reasons behind forking the Learn theme, see this comment in the Learn issues.

# Requirements

Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.

Just download at least version 0.95.0 of the Hugo binary for your OS (Windows, Linux, Mac).

# Installation

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 great documentation for beginners.

## Create your project

Hugo provides a `new` command to create a new website.

    hugo new site <new_project>

## Install the theme

Install the Relearn theme by following this documentation using Hugo’s module system.

This theme’s repository is: https://github.com/McShelby/hugo-theme-relearn.git

Alternatively, you can download the theme as .zip file and extract it in the `themes` directory

### From Git

If you install the theme from your git repository or GitHub, you have several options.

If you use the `head` of the `main` 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.

Additionally you can checkout one of the tagged versions. These tagged versions correspond to an official releases from the GitHub repository.

Besides the usual version tags (eg `1.2.3`) there are also tags for the main version (eg. `1.2.x`), major version (eg. `1.x`) and the latest (just `x`) released version making it easier for you to pin the theme to a certain version.

## Basic configuration

When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (`config.toml`) and set the theme as the default. You can also add the `[outputs]` section to enable the search functionality.

    # Change the default theme to be use when building the site with Hugo
    theme = "hugo-theme-relearn"

    # For search functionality
    [outputs]
    home = [ "HTML", "RSS", "SEARCH"]

## Create your first chapter page

Chapters are pages that contain other child pages. It has a special layout style and usually just contains a chapter name, the title and a brief abstract of the section.

    ### Chapter 1

    # Basics

    Discover what this Hugo theme is all about and the core concepts behind it.

renders as

The Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command

    hugo new --kind chapter basics/_index.md

By opening the given file, you should see the property `chapter=true` on top, meaning this page is a chapter.

By default all chapters and pages are created as a draft. If you want to render these pages, remove the property `draft: true` from the metadata.

## Create your first content pages

Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:

    hugo new basics/first-content.md
    hugo new basics/second-content/_index.md

Feel free to edit those files by adding some sample content and replacing the `title` value in the beginning of the files.

## Launching the website locally

Launch by using the following command:

    hugo serve

Go to `http://localhost:1313`

You should notice three things:

1. You have a left-side Basics menu, containing two submenus with names equal to the `title` properties in the previously created files.
2. The home page explains how to customize it by following the instructions.
3. When you run `hugo serve`, when the contents of the files change, the page automatically refreshes with the changes. Neat!

## Build the website

When your site is ready to deploy, run the following command:

    hugo

A `public` folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.

Note

This website can be automatically published and hosted with Netlify (Read more about Automated HUGO deployments with Netlify). Alternatively, you can use GitHub pages.

# Configuration

## Global site parameters

On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your `config.toml` (here, values are default).

Note that some of these parameters are explained in details in other sections of this documentation.

    [params]
      # This controls whether submenus will be expanded (true), or collapsed (false) in the
      # menu; if no setting is given, the first menu level is set to false, all others to true;
      # this can be overridden in the pages frontmatter
      alwaysopen = true
      # Prefix URL to edit current page. Will display an "Edit" button on top right hand corner of every page.
      # Useful to give opportunity to people to create merge request for your doc.
      # See the config.toml file from this documentation site to have an example.
      editURL = ""
      # Author of the site, will be used in meta information
      author = ""
      # Description of the site, will be used in meta information
      description = ""
      # Shows a checkmark for visited pages on the menu
      showVisitedLinks = false
      # Disable search function. It will hide search bar
      disableSearch = false
      # Disable search in hidden pages, otherwise they will be shown in search box
      disableSearchHiddenPages = false
      # Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines
      disableSeoHiddenPages = false
      # Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden
      disableTagHiddenPages = false
      # Javascript and CSS cache are automatically busted when new version of site is generated.
      # Set this to true to disable this behavior (some proxies don't handle well this optimization)
      disableAssetsBusting = false
      # Set this to true if you want to disable generation for generator version meta tags of hugo and the theme;
      # don't forget to also set Hugo's disableHugoGeneratorInject=true, otherwise it will generate a meta tag into your home page
      disableGeneratorVersion = false
      # Set this to true to disable copy-to-clipboard button for inline code.
      disableInlineCopyToClipBoard = false
      # A title for shortcuts in menu is set by default. Set this to true to disable it.
      disableShortcutsTitle = false
      # If set to false, a Home button will appear below the search bar on the menu.
      # It is redirecting to the landing page of the current language if specified. (Default is "/")
      disableLandingPageButton = true
      # When using mulitlingual website, disable the switch language button.
      disableLanguageSwitchingButton = false
      # Hide breadcrumbs in the header and only show the current page title
      disableBreadcrumb = true
      # If set to true, hide table of contents menu in the header of all pages
      disableToc = false
      # If set to false, load the MathJax module on every page regardless if a MathJax shortcode is present
      disableMathJax = false
      # Specifies the remote location of the MathJax js
      customMathJaxURL = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
      # Initialization parameter for MathJax, see MathJax documentation
      mathJaxInitialize = "{}"
      # If set to false, load the Mermaid module on every page regardless if a Mermaid shortcode or Mermaid codefence is present
      disableMermaid = false
      # Specifies the remote location of the Mermaid js
      customMermaidURL = "https://unpkg.com/mermaid/dist/mermaid.min.js"
      # Initialization parameter for Mermaid, see Mermaid documentation
      mermaidInitialize = "{ \"theme\": \"default\" }"
      # If set to false, load the Swagger module on every page regardless if a Swagger shortcode is present
      disableSwagger = false
      # Specifies the remote location of the RapiDoc js
      customSwaggerURL = "https://unpkg.com/rapidoc/dist/rapidoc-min.js"
      # Initialization parameter for Swagger, see RapiDoc documentation
      swaggerInitialize = "{ \"theme\": \"light\" }"
      # Hide Next and Previous page buttons normally displayed full height beside content
      disableNextPrev = true
      # Order sections in menu by "weight" or "title". Default to "weight";
      # this can be overridden in the pages frontmatter
      ordersectionsby = "weight"
      # Change default color scheme with a variant one. Eg. can be "auto", "red", "blue", "green" or an array like [ "blue", "green" ].
      themeVariant = "auto"
      # Change the title separator. Default to "::".
      titleSeparator = "-"
      # 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
      collapsibleMenu = false
      # If a single page can contain content in multiple languages, add those here
      additionalContentLanguage = [ "en" ]
      # If set to true, no index.html will be appended to prettyURLs; this will cause pages not
      # to be servable from the file system
      disableExplicitIndexURLs = false
      # 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
      externalLinkTarget = "_blank"

## Serving your page from a subfolder

If your site is served from a subfolder, eg. `https://example.com/mysite/`, you have to set the following lines to your `config.toml`

    baseURL = "https://example.com/mysite/"
    canonifyURLs = true
    relativeURLs = true

Without `canonifyURLs=true` URLs in sublemental pages (like `sitemap.xml`, `rss.xml`) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.

## Serving your page from the filesystem

If you want your page served from the filesystem by using URLs starting with `file://` you’ll need the following configuration in your `config.toml`:

    relativeURLs = true

The theme will append an additional `index.html` 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 `config.toml`

    [params]
      disableExplicitIndexURLs = true

Note

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 `JSON` to `SEARCH` as seen below.

## Activate search

If not already present, add the following lines in the same `config.toml` file.

    [outputs]
      home = ["HTML", "RSS", "SEARCH"]

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 `SEARCH` outputformat was named `JSON` in previous releases but was implemented differently. Although `JSON` still works, it is now deprecated.

### Activate dedicated search page

You can add a dedicated search page for your page by adding the `SEARCHPAGE` outputformat to your home page by adding the following lines in your `config.toml` file.

    [outputs]
      home = ["HTML", "RSS", "SEARCH", "SEARCHPAGE"]

You can access this page by either clicking on the magnifier glass or by typing some search term and pressing `ENTER` inside of the menu’s search box .

## Activate print support

You can activate print support to add the capability to print whole chapters or even the complete site. Just add the `PRINT` output format to your home, section and page in your `config.toml` as seen below:

    [outputs]
      home = ["HTML", "RSS", "PRINT", "SEARCH"]
      section = ["HTML", "RSS", "PRINT"]
      page = ["HTML", "RSS", "PRINT"]

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.

Note

The resulting URL will not be configured ugly in terms of Hugo’s URL handling even if you’ve set `uglyURLs=true` in your `config.toml`. This is due to the fact that for one mime type only one suffix can be configured.

Nevertheless, if you’re unhappy with the resulting URLs you can manually redefine `outputFormats.PRINT` in your own `config.toml` to your liking.

## MathJax

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 Math for additional documentation.

### Example

MathJax is globally disabled. By default it won’t be loaded by any page.

On page “Physics” you coded some JavaScript for a dynamic formulae. You can set the MathJax parameters locally to load mathJax on this page.

You also can disable MathJax for specific pages while globally enabled.

## Mermaid

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 Mermaid for additional documentation.

### Example

Mermaid is globally disabled. By default it won’t be loaded by any page.

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.

You also can disable Mermaid for specific pages while globally enabled.

## Home Button Configuration

If the `disableLandingPageButton` option is set to `false`, a Home button will appear on the left menu. It is an alternative for clicking on the logo. To edit the appearance, you will have to configure two parameters for the defined languages:

    [Languages]
    [Languages.en]
    ...
    landingPageName = "<i class='fas fa-home'></i> Home"
    ...
    [Languages.pir]
    ...
    landingPageName = "<i class='fas fa-home'></i> Arrr! Homme"
    ...

If those params are not configured for a specific language, they will get their default values:

    landingPageName = "<i class='fas fa-home'></i> Home"

The home button is going to look like this:

# Customization

The Relearn theme has been built to be as configurable as possible by defining multiple partials

In `themes/hugo-theme-relearn/layouts/partials/`, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead follow this page. You’d create a new partial in the `layouts/partials` folder of your local project. This partial will have the priority.

This theme defines the following partials :

- `header.html`: the header of the page. See output-formats
- `footer.html`: the footer of the page. See output-formats
- `body.html`: the body of the page. The body may contain of one or many articles. See output-formats
- `article.html`: the output for a single article, can contain elements around your content. See output-formats
- `menu.html`: left menu. Not meant to be overwritten
- `search.html`: search box. Not meant to be overwritten
- `custom-header.html`: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include `style` HTML tag directive in your file.
- `custom-footer.html`: custom footer in page. Meant to be overwritten when adding JavaScript. Don’t forget to include `javascript` HTML tag directive in your file.
- `favicon.html`: the favicon
- `heading-pre.html`: side-wide configuration to prepend to pages title headings. If you override this, it is your responsibility to take the page’s `headingPre` setting into account.
- `heading-post.html`: side-wide configuration to append to pages title headings. If you override this, it is your responsibility to take the page’s `headingPost` setting into account.
- `logo.html`: the logo, on top left hand corner
- `meta.html`: HTML meta tags, if you want to change default behavior
- `menu-pre.html`: side-wide configuration to prepend to menu items. If you override this, it is your responsibility to take the page’s `menuPre` setting into account.
- `menu-post.html`: side-wide configuration to append to menu items. If you override this, it is your responsibility to take the page’s `menuPost` setting into account.
- `menu-footer.html`: footer of the the left menu
- `toc.html`: table of contents
- `content.html`: the content page itself. This can be overridden if you want to display page’s meta data above or below the content.
- `content-footer`: footer below the content, has a default implementation but you can overwrite it if you don’t like it.

## Change the logo

Create a new file in `layouts/partials/` named `logo.html`. Then write any HTML you want. You could use an `img` HTML tag and reference an image created under the static folder, or you could paste a SVG definition!

Note

The size of the logo will adapt automatically

## Change the favicon

If your favicon is a SVG, PNG or ICO, just drop off your image in your local `static/images/` folder and name it `favicon.svg`, `favicon.png` or `favicon.ico` respectively.

If no favicon file is found, the theme will lookup the alternative filename `logo` in the same location and will repeat the search for the list of supported file types.

If you need to change this default behavior, create a new file in `layouts/partials/` named `favicon.html`. Then write something like this:

    <link rel="icon" href="/images/favicon.bmp" type="image/bmp">

## Change the colors

The Relearn theme lets you choose between some predefined color variants in light or dark mode, but feel free to add one yourself!

You can preview the shipped variants by changing them in the variant selector at the bottom of the menu.

### Single variant

Set the `themeVariant` value with the name of your theme file. That’s it!

    [params]
      themeVariant = "relearn-light"

In the above example your theme file has to be named `theme-relearn-light.css`

### Multiple variants

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.

    [params]
      # Change default color scheme with a variant one.
      themeVariant = [ "relearn-light", "relearn-dark" ]

Tip

If you want to switch the syntax highlighting theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation according to Hugo’s documentation, and `@import` this stylesheet in your color variant stylesheet. For an example, take a look into `theme-relearn-light.css` and `config.toml` of the exampleSite.

### Adjust to OS Settings

You can also cause the site to adjust to your OS settings for light/dark mode. Just set the `themeVariant` to `auto`. That’s it.

If you’ve set multiple variants, you can drop `auto` at any position, but usually it makes sense to set it in the first position and make it the default.

    [params]
      themeVariant = [ "auto", "red" ]

If you don’t configure anything else, the theme will use `relearn-light` for light mode and `relearn-dark` for dark mode.

If you don’t like that, you can set `themeVariantAuto`. The first element is the variant for light mode, the second for dark mode

    [params]
      themeVariantAuto = [ "learn", "neon" ]

Note

This is not supported for Internet Explorer 11, which still displays in the `relearn-light` variant.

### Roll your own

If you are not happy with the shipped variants you can either copy and rename one of the shipped files from `themes/hugo-theme-relearn/static/css` to `static/css`, edit them afterwards to your liking in a text editor and configure the `themeVariant` parameter in your `config.toml` or just use the interactive variant generator.

### Output formats

Certain parts of the theme can be changed for support of your own output formats. Eg. if you define a new output format `PLAINTEXT` in your `config.toml`, you can add a file `layouts/partials/header.plaintext.html` to change the way, the page header should look like for that output format.

# Stylesheet generator

This interactive tool may help you to generate your own color variant stylesheet.

To get started, first select a color variant from the variant switch that fits you best as a starting point.

The graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph and the page will update accordingly.

The arrowed lines reflects how colors are inherited thru different parts of the theme if the descendent isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.

To better understand this select the `neon` variant and modify the different heading colors. There, colors for the heading `h2`, `h3` and `h4` are explicitly set. `h5` is not set and inherits its value from `h4`. `h6` is also not set and inherits its value from `h5`.

Once you’ve changed a color, the variant switch will show a “My custom variant” entry and your changes are stored in the browser. You can change pages and even close the browser without losing your changes.

Once you are satisfied, you can download the new variants file and copy it into your site’s `static/css` directory. Afterwards you have to adjust the `themeVariant` parameter in your `config.toml` to your chosen file name.

Eg. if your new variants file is named `theme-my-custom-variant.css`, you have to set `themeVariant='my-custom-variant'` to use it.

Note

This only works in modern browsers.

## Variant generator

Graph

# History

# Changelog

## 5.11.1 (2023-02-06)

### Fixes

- [bug] variant: include missing `theme-auto.css` in distribution #467

## 5.11.0 (2023-02-05)

### Enhancements

- [feature] i18n: add Czech translation #455
- [feature][change] lightbox: switch to CSS-only solution #451
- [feature][change] variant: add support for `prefers-color-scheme` #445
- [feature][change] expand: refactor for a11y #339
- [feature][change] mermaid: make zoom configurable #144

### Fixes

- [bug] swagger: avoid errors when using invalid rapi-doc fragment ids #465
- [bug] search: fix oddities in keyboard handling #463
- [bug] badge: fix text color for IE11 #462
- [bug] mermaid: rerender graph if search term is present and variant is switched #460
- [bug] tags: show tag on pages when tag has space #459
- [bug] edit: remove double slash on root page link #450

### Maintenance

- [task] build: add moving version tags #453
- [task][change] theme: remove jQuery #452
- [task] build: check for release notes before release #448

## 5.10.2 (2023-01-25)

### Fixes

- [bug] nav: fix breadcrumb for huge installations #446

## 5.10.1 (2023-01-25)

### Fixes

- [bug] print: fix image links with relative path #444

## 5.10.0 (2023-01-25)

### Enhancements

- [feature] shortcodes: support for accent color #440
- [feature] shortcodes: add color parameter where applicable #438
- [feature] theme: announce translations as alternate links #422

### Fixes

- [bug] nav: fix breadcrumbs for deeply nested sections #442
- [bug] theme: improve whitespacing in tables #441

## 5.9.4 (2023-01-23)

### Fixes

- [bug] variant: fix search icon and text color #437

## 5.9.3 (2023-01-22)

### Fixes

- [bug] nav: fix left/right navigation for horizontal scrolling #435
- [bug] theme: allow pages on top level #434

### Maintenance

- [task] build: switch to wildcard version of actions #428

## 5.9.2 (2022-12-30)

### Fixes

- [bug] search: apply dependency scripts for Hindi and Japanese #427

## 5.9.1 (2022-12-23)

### Enhancements

- [feature] theme: make external link target configurable #426

## 5.9.0 (2022-12-23)

### Enhancements

- [feature][change] theme: open external links in separate tab #419
- [feature] theme: make it a Hugo module #417

### Fixes

- [bug][change] attachments: fix incorrect links for defaultContentLanguageInSubdir=true #425

## 5.8.1 (2022-12-11)

### Fixes

- [bug] theme: fix alias for home page if defaultContentLanguageInSubdir=true #414

## 5.8.0 (2022-12-08)

### Enhancements

- [feature] icon: add new shortcode #412
- [feature] theme: style and document markdown extensions #411
- [feature] badge: add new shortcode #410
- [feature] theme: add accent color #409

### Fixes

- [bug] theme: fix spacing for tag flyout in FF #413

## 5.7.0 (2022-11-29)

### Enhancements

- [feature] button: refactor for a11y #372

### Fixes

- [bug] search: don’t freeze browser on long search terms #408
- [bug] search: fix searchbox placeholder color in FF and IE #405
- [bug][change] i18n: rename Korean translation from country to lang code #404

### Maintenance

- [task] search: update lunr languages to 1.10.0 #403

## 5.6.6 (2022-11-23)

### Enhancements

- [feature] search: make build and js forgiving against config errors #400

### Fixes

- [bug] variant: minor color adjustments #402
- [bug] variant: fix generator for use of neon #401

## 5.6.5 (2022-11-19)

### Fixes

- [bug] menu: relax usage of background color #399

## 5.6.4 (2022-11-19)

### Fixes

- [bug] theme: make alias pages usable by file:// protocol #398

## 5.6.3 (2022-11-19)

### Fixes

- [bug] theme: be compatible with Hugo >= 0.95.0 #397

## 5.6.2 (2022-11-19)

### Fixes

- [bug] theme: build breaks sites without “output” section in config #396

## 5.6.1 (2022-11-19)

### Fixes

- [bug] theme: fix image distortion #395

## 5.6.0 (2022-11-18)

### Enhancements

- [feature] toc: improve keyboard handling #390
- [feature] search: improve keyboard handling #387
- [feature] search: add dedicated search page #386
- [feature] theme: make creation of generator meta tag configurable #383
- [feature] theme: increase build performance #380

### Fixes

- [bug] mermaid: avoid leading whitespace #394
- [bug] theme: fix build errors when referencing SVGs in markdown #393
- [bug] variant: avoid neon to leak into IE11 fallback #392
- [bug] theme: fix urls for file:// protocol in sitemap #385
- [bug] theme: add id to h1 elements #384
- [bug] rss: fix display of hidden subpages #382
- [bug] nav: fix key navigation when pressing wrong modifiers #379

### Maintenance

- [task] mermaid: update to version 9.2.2 #391

## 5.5.3 (2022-11-10)

### Fixes

- [bug] tags: fix non-latin tag display on pages #378

## 5.5.2 (2022-11-08)

### Fixes

- [bug] theme: fix typo in 404.html #376
- [bug] theme: allow menu items and children to be served by file:// protocol #375

## 5.5.1 (2022-11-07)

### Fixes

- [bug] theme: fix overflowing issue with anchors and tooltips #364

## 5.5.0 (2022-11-06)

### Enhancements

- [feature][change] theme: optimize page load for images #304

### Fixes

- [bug] theme: fix context in render hooks #373
- [bug] print: make canonical URL absolute #371

## 5.4.3 (2022-11-05)

### Enhancements

- [feature] history: refactor for a11y #341

### Fixes

- [bug] theme: fix multilang links when site served from subdirectory #370

## 5.4.2 (2022-11-05)

### Maintenance

- [task] build: change set-output to env vars #348

## 5.4.1 (2022-11-05)

### Fixes

- [bug] mermaid: fix Gantt chart width #365

## 5.4.0 (2022-11-01)

### Enhancements

- [feature] math: allow passing of parameters with codefence syntax #363
- [feature] i18n: add Finnish translation #361
- [feature] mermaid: allow passing of parameters with codefence syntax #360
- [feature] i18n: support RTL #357
- [feature][change] button: add option for target #351
- [feature][change] theme: allow to be served by file:// protocol #349

## 5.3.3 (2022-10-09)

### Fixes

- [bug] archetypes: fix frontmatter on home.md template #346

## 5.3.2 (2022-10-08)

### Fixes

- [bug] nav: change defunct keyboard shortcuts #344

## 5.3.1 (2022-10-08)

### Enhancements

- [feature] i18n: update Spanish translation #343
- [feature] theme: option to align images #327

## 5.3.0 (2022-10-07)

### Enhancements

- [feature] expander: improve whitespace between label and content #338
- [feature] swagger: improve print version #333

### Fixes

- [bug] print: fix links of subsections #340
- [bug] theme: remove W3C validator errors #337
- [bug] children: remove unused `page` parameter from docs #336
- [bug] print: remove menu placeholder in Firefox #335
- [bug] swagger: fix download button overflow #334
- [bug][change] a11y: remove WCAG errors where applicable #307

## 5.2.4 (2022-10-02)

### Fixes

- [bug] theme: remove HTML5 validator errors #329

## 5.2.3 (2022-09-12)

### Fixes

- [bug] print: chapter pages overwrite font-size #328

## 5.2.2 (2022-08-23)

### Fixes

- [bug] print: fix urls for uglyURLs=true #322

## 5.2.1 (2022-08-05)

### Enhancements

- [feature] i18n: improve Japanese translation #318

### Fixes

- [bug] nav: prev/next ignores ordersectionby #320

### Maintenance

- [task] task: bump Hugo minimum requirement to 0.95 #319

## 5.2.0 (2022-08-03)

### Enhancements

- [feature][change] menu: expand collapsed menus if search term is found in submenus #312

### Fixes

- [bug] print: switch mermaid and swagger style before print #316
- [bug] theme: fix chapter margins on big screens #315

## 5.1.2 (2022-07-18)

### Fixes

- [bug] print: reset mermaid theme to light #313
- [bug] mermaid: header is showing up in FF #311

## 5.1.1 (2022-07-15)

### Fixes

- [bug] tags: don’t count tags if page is hidden #310

## 5.1.0 (2022-07-15)

### Enhancements

- [feature][change] print: make print url deterministic #309
- [feature] theme: allow overriding partials for output formats #308

## 5.0.3 (2022-07-07)

### Fixes

- [bug] ie11: no styles after rework of archetypes #306

## 5.0.2 (2022-07-07)

### Fixes

- [bug] theme: load CSS if JS is disabled #305

## 5.0.1 (2022-07-07)

### Enhancements

- [feature][breaking] theme: optimize loading of js and css #303

## 5.0.0 (2022-07-05)

### Enhancements

- [feature][change] archetypes: modularize rendering #300
- [feature] history: don’t reload page when history gets cleared #299
- [feature] menu: replace expander by fontawesome chevrons #296
- [feature] theme: align content with topbar icon limits #290
- [feature] button: allow for empty href #288
- [feature] i18n: make Simplified Chinese the standard language for the `zn` code #287
- [feature] clipboard: move head styles to stylesheet #286
- [feature] math: add mathjax rendering #235
- [feature] theme: allow for page heading modification #139

### Fixes

- [bug] favicon: fix URL if site resides in subfolder #302
- [bug] code: show copy-to-clipboard marker for blocklevel code #298
- [bug] menu: make active expander visible on hover #297
- [bug] print: disable arrow navigation #294
- [bug] print: add missing page break after index or section #292
- [bug] theme: use more space on wide screens #291
- [bug] theme: fix size of chapter heading #289

### Maintenance

- [task] chore: update RapiDoc 9.3.3 #301
- [task] chore: update Mermaid 9.1.3 #293

## 4.2.5 (2022-06-23)

### Fixes

- [bug] swagger: javascript code does not load in documentation #285
- [bug] children: descriptions not working #284
- [bug] print: fix empty page for shortcut links #283

## 4.2.4 (2022-06-23)

### Fixes

- [bug] theme: fix url for logo and home button #282

## 4.2.3 (2022-06-23)

### Fixes

- [bug][breaking] include: second parameter is ignored #281

## 4.2.2 (2022-06-23)

No changelog for this release.

## 4.2.1 (2022-06-23)

No changelog for this release.

## 4.2.0 (2022-06-23)

### Enhancements

- [feature][change] tabs: don’t change tab selection if panel does not contain item #279
- [feature] shortcodes: convert to partials #277

### Fixes

- [bug] swagger: avoid builtin syntax-highlightning #280
- [bug] search: fix console message for missing lunr translations #278
- [bug] tabs: fix wrapping when having many tabs #272

## 4.1.1 (2022-06-18)

### Fixes

- [bug] notice: fix layout when content starts with heading #275

## 4.1.0 (2022-06-12)

### Enhancements

- [feature] i18n: support multilang content #271

## 4.0.5 (2022-06-12)

### Fixes

- [bug] i18n: Vietnamese language with wrong lang code #270
- [bug] i18n: fix search for non western languages #269

## 4.0.4 (2022-06-07)

### Enhancements

- [feature] theme: improve keyboard navigation for scrolling #268

### Fixes

- [bug] swagger: adjust font-size for method buttons #267
- [bug] menu: hide expander when only hidden subpages #264
- [bug] theme: make compatible with Hugo 0.100.0 #263

### Maintenance

- [task] swagger: update rapidoc to 9.3.2 #266
- [task] mermaid: update to 9.1.1 #265

## 4.0.3 (2022-06-05)

### Enhancements

- [feature] toc: add scrollbar #262

## 4.0.2 (2022-06-05)

### Fixes

- [bug] theme: let browser scroll page on CTRL+f #242

## 4.0.1 (2022-06-05)

No changelog for this release.

## 4.0.0 (2022-06-05)

### Enhancements

- [feature] shortcodes: add named parameter if missing #260
- [feature][breaking] theme: remove –MAIN-ANCHOR-color from stylesheet #256
- [feature] i18n: add Italian translation #254
- [feature] attachments: support for brand colors #252
- [feature] notice: support for brand colors #251
- [feature][breaking] config: remove custom_css #248
- [feature] theme: use proper file extension for page-meta.go #246
- [feature] variant: add support for brand color variables #239
- [feature] i18n: add Polish translation #237

### Fixes

- [bug] shortcodes: accept boolean parameters if given as string #261
- [bug] print: adjust button and tab size #259
- [bug] print: show Mermaid if requested in frontmatter #255
- [bug] theme: adjust thin scrollbar slider #244
- [bug] mobile: fix broken scrollbar #243
- [bug] theme: fix display of tooltip for heading anchor #241

## 3.4.1 (2022-04-03)

### Fixes

- [bug] theme: fix IE11 incompatibilities #234

## 3.4.0 (2022-04-03)

### Enhancements

- [feature] i18n: add Traditional Chinese translation #233
- [feature] menu: expand/collapse menu items without navigation #231
- [feature] print: add option to print whole chapter #230
- [feature][breaking] theme: apply user supplied content footer below content #229

### Fixes

- [bug] theme: scroll to heading on initial load #232

## 3.3.0 (2022-03-28)

### Enhancements

- [feature] theme: add CSS font variables #227
- [feature] swagger: add support for oas/swagger documentation #226

### Fixes

- [bug] variant: make variant switch work on slow networks #228

## 3.2.1 (2022-03-25)

### Fixes

- [bug] print: fix minor inconsistencies #225
- [bug] print: show more than just the title page #224
- [bug] theme: align content scrollbar to the right on big screens #223

## 3.2.0 (2022-03-19)

### Enhancements

- [feature][change] mermaid: support differing themes for color variant switch #219
- [feature] mermaid: load javascript on demand #218

### Maintenance

- [task] mermaid: update to 8.14.0 #220

## 3.1.1 (2022-03-16)

### Enhancements

- [feature] i18n: add Korean translation #217

## 3.1.0 (2022-03-15)

### Enhancements

- [feature] notice: add icon parameter #212
- [feature] mobile: remove breadcrumb ellipsis #211

### Fixes

- [bug] theme: make storage of multiple Hugo sites on same server distinct #214
- [bug] variant: switch breadcrumb color in Chrome #213
- [bug] mobile: improve behavior of sidebar menu #210

## 3.0.4 (2022-02-24)

### Enhancements

- [feature] theme: improve font loading #201
- [feature][change] variant: fix inconsistent color variable naming #200

### Fixes

- [bug] variant: fix occasional fail when resetting generator #208
- [bug] docs: don’t move header on logo hover in IE11 #207
- [bug] variant: avoid flash of menu header when non default variant is active #206
- [bug] theme: fix wrong HTML closing tag order in chapters #205
- [bug] theme: adjust breadcrumb and title for empty home page titles #202

## 3.0.3 (2022-02-23)

### Enhancements

- [feature] tags: show tag count in taxonomy list #195

### Fixes

- [bug] theme: remove Hugo build warning if page is not file based #197
- [bug] tags: adhere to titleSeparator #196
- [bug] theme: hide footer divider and variant selector in IE11 #194

## 3.0.2 (2022-02-23)

### Enhancements

- [feature] tags: sort by name #193

## 3.0.1 (2022-02-23)

### Enhancements

- [feature] children: set containerstyle automatically according to style #192

### Fixes

- [bug] theme: revert fontawsome to version 5 for IE11 compat #191

## 3.0.0 (2022-02-22)

### Enhancements

- [feature] variant: build a variant generator #188
- [feature] nav: only show toc if the page has headings #182
- [feature][breaking] theme: change default colors to Relearn defaults #181
- [feature] variant: add a variant selector #178
- [feature][breaking] menu: rework footer UX #177
- [feature] theme: support for dark mode #175
- [feature] docs: use light syntax highlightning theme #174
- [feature] notice: tweak dull colors #173
- [feature] theme: rework header UX #151

### Fixes

- [bug] search: remove additional X in filled out search box in IE11 #190
- [bug] clipboard: localize tooltips #186
- [bug] print: hide sidebar on Mac #183
- [bug] menu: fix scrollbar height #180
- [bug][change] search: fix color change for icons on hover #176

## 2.9.6 (2022-02-07)

### Fixes

- [bug] menu: remove debug output #171

## 2.9.5 (2022-02-07)

### Fixes

- [bug] menu: let arrow navigation respect ordersectionsby configuration #170

## 2.9.4 (2022-02-06)

### Fixes

- [bug] exampleSite: fix links in official documentation #168

## 2.9.3 (2022-02-06)

### Fixes

- [bug] menu: invalid URL when the shortcut is an internal link #163

## 2.9.2 (2021-11-26)

### Enhancements

- [feature] theme: add theme version info to head #158

### Fixes

- [bug] theme: fix selection of *.ico files as favicons #160

## 2.9.1 (2021-11-22)

### Fixes

- [bug] menu: fix significantly low performance for collecting of meta info #157

## 2.9.0 (2021-11-19)

### Fixes

- [bug][breaking] relref: fix inconsistent behavior #156
- [bug] search: make dropdown stick to search field when scrolling #155
- [bug] menu: align long text properly #154
- [bug] copyToClipBoard: add missing right border for inline code if `disableInlineCopyToClipBoard=true` #153
- [bug] menu: show hidden sibling pages reliably #152
- [bug] menu: bring active item in sight for large menus #149

## 2.8.3 (2021-11-09)

### Fixes

- [bug] mermaid: let zoom reset to initial size #145
- [bug] mermaid: remove whitespace from big graphs #143

## 2.8.2 (2021-11-08)

### Fixes

- [bug] mermaid: always load javascript to avoid break if code fences are used #142

## 2.8.1 (2021-11-04)

### Fixes

- [bug] search: don’t break JS in multilang setup if search is disabled #140

## 2.8.0 (2021-11-03)

### Enhancements

- [feature] toc: make disableTOC globally available via config.toml #133
- [feature] mermaid: only load javascript if necessary #95
- [feature][change] theme: switch font #83
- [feature] theme: make favicon configurable #2

### Fixes

- [bug] mermaid: assert that window.mermaid is actually mermaid #136
- [bug] menu: remove usage of Hugos UniqueID #131
- [bug] theme: reduce margin for children shortcode #130
- [bug] theme: left-align h3 in chapters #129
- [bug] theme: align copy link to clipboard #128

## 2.7.0 (2021-10-24)

### Enhancements

- [feature] notice: support custom titles #124

## 2.6.0 (2021-10-21)

### Fixes

- [bug] theme: generate correct links if theme served from subdirectory #120

## 2.5.1 (2021-10-12)

### Fixes

- [bug] security: fix XSS for malicioius image URLs #117

## 2.5.0 (2021-10-08)

### Enhancements

- [feature][change] syntax highlight: provide default colors for unknown languages #113

### Fixes

- [bug] security: fix XSS for malicioius URLs #114
- [bug] menu: write correct local shortcut links #112

## 2.4.1 (2021-10-07)

### Fixes

- [bug] theme: remove runtime styles from print #111

## 2.4.0 (2021-10-07)

### Enhancements

- [feature] lang: add vietnamese translation #109
- [feature][change] theme: simplify stylesheet for color variants #107
- [feature] hidden pages: remove from RSS feed, JSON, taxonomy etc #102
- [feature] theme: announce alternative content in header #101
- [feature] menu: frontmatter option to change sort predicate #98
- [feature] menu: add default setting for menu expansion #97
- [feature] theme: improve print style #93
- [feature] theme: improve style #92

### Fixes

- [bug] include: don’t generate additional HTML if file should be displayed “as is” #110
- [bug] attachments: fix broken links if multilang config is used #105
- [bug] theme: fix sticky header to remove horizontal scrollbar #82

### Maintenance

- [task] chore: update fontawesome #94

## 2.3.2 (2021-09-20)

### Fixes

- [bug] docs: rename history pirate translation #91

## 2.3.1 (2021-09-20)

### Fixes

- [bug] docs: rename english pirate translation to avoid crash on rendering #90

## 2.3.0 (2021-09-13)

### Fixes

- [bug] theme: fix usage of section element #88

### Maintenance

- [task] theme: ensure IE11 compatiblity #89
- [task] docs: Arrr! showcase multilang featurrre #87

## 2.2.0 (2021-09-09)

### Enhancements

- [feature] sitemap: hide hidden pages from sitemap and SEO indexing #85

### Fixes

- [bug] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs #86

### Maintenance

- [task] theme: switch from data-vocabulary to schema #84

## 2.1.0 (2021-09-07)

### Enhancements

- [feature] search: open expand if it contains search term #80
- [feature] menu: scroll active item into view #79
- [feature] search: disable search in hidden pages #76
- [feature] search: improve readablility of index.json #75
- [feature] search: increase performance #74
- [feature] search: improve search context preview #73

### Fixes

- [bug][change] search: hide non-site content #81
- [bug] menu: always hide hidden sub pages #77

## 2.0.0 (2021-08-28)

### Enhancements

- [feature] tabs: enhance styling #65
- [feature] theme: improve readability #64
- [feature] menu: show hidden pages if accessed directly #60
- [feature][change] theme: treat pages without title as hidden #59
- [feature] search: show search results if field gains focus #58
- [feature] theme: add partial templates for pre/post menu entries #56
- [feature] theme: make chapter archetype more readable #55
- [feature] children: add parameter for container style #53
- [feature] theme: make content a template #50
- [feature] menu: control menu expansion with alwaysopen parameter #49
- [feature] include: new shortcode to include other files #43
- [feature] theme: adjust print styles #35
- [feature][change] code highlighter: switch to standard hugo highlighter #32

### Fixes

- [bug][change] arrow-nav: default sorting ignores ordersectionsby #63
- [bug][change] children: default sorting ignores ordersectionsby #62
- [bug][change] arrow-nav: fix broken links on (and below) hidden pages #61
- [bug] theme: remove superfluous singular taxonomy from taxonomy title #46
- [bug][change] theme: missing –MENU-HOME-LINK-HOVER-color in documentation #45
- [bug] theme: fix home link when base URL has some path #44

### Maintenance

- [task] docs: include changelog in exampleSite #33

## 1.2.0 (2021-07-26)

### Enhancements

- [feature] theme: adjust copy-to-clipboard #29
- [feature] attachments: adjust style between notice boxes and attachments #28
- [feature] theme: adjust blockquote contrast #27
- [feature] expand: add option to open on page load #25
- [feature] expand: rework styling #24
- [feature] attachments: sort output #23
- [feature] notice: make restyling of notice boxes more robust #20
- [feature] notice: fix contrast issues #19
- [feature] notice: align box colors to common standards #18
- [feature] notice: use distinct icons for notice box type #17

### Fixes

- [bug] attachments: support i18n for attachment size #21
- [bug] notice: support i18n for box labels #16
- [bug] notice: support multiple blocks in one box #15

### Maintenance

- [task] dependency: upgrade jquery to 3.6.0 #30

## 1.1.1 (2021-07-04)

### Maintenance

- [task] theme: prepare for new hugo theme registration #13

## 1.1.0 (2021-07-02)

### Enhancements

- [feature] mermaid: expose options in config.toml #4

### Fixes

- [bug] mermaid: config option for CDN url not used #12
- [bug] mermaid: only highlight text in HTML elements #10
- [bug] mermaid: support pan & zoom for graphs #9
- [bug] mermaid: code fences not always rendered #6
- [bug] mermaid: search term on load may bomb chart #5

### Maintenance

- [task] mermaid: update to 8.10.2 #7

## 1.0.1 (2021-07-01)

### Maintenance

- [task] Prepare for hugo showcase #3

## 1.0.0 (2021-07-01)

### Maintenance

- [task] Fork project #1