What's New

This document shows you what’s new in the latest release and flags it with one of the following badges. For a detailed list of changes, see the history page.

• 0.112.4 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.24.0.beta

• 0.112.4 This release requires a newer Hugo version.

• Change The topbar button received a way to add text next to the icon. For this, the original title option was renamed to hint while the new title option is now displayed next to the icon.

• Change The light themes have a bit more contrast for content text and headings. Also the syntaxhighlighting was changed to the more colorful MonokaiLight. This brings the syntaxhighlightning in sync with the corresponding dark theme variants, which are using Monokai. If you dislike this, you can create your own color variant file as described here.

• New You now can configure additional options for every theme variant in your hugo.toml. This allows for optional advanced functionality. You don’t need to change anything as the old configuration options will still work (but may generate warnings now).

  The advanced functionality allows you to set an explicit name for a theme variant, set different colors (if you are using monochrome SVGs) or even different icons (handy if you want to adjust colors for PNGs, GIFs or JPGs) and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.

• New New partial for defining the heading. See documentation for further reading.

• New Support for Hugo’s built-in figure shortcode.

• New On taxonomy and term pages you can now use prev/next navigation as within the normal page structure.

• New Improvements for accessibility when tabbing thru the page for images, links and tab handles.

• New The themes config and frontmatter options received a comprehensive documentation update. In addition the theme switched from config.toml to hugo.toml.

5.23.0 (2023-11-03)

• Change With 0.120.0 the author settings move into the [params] array in your hugo.toml. Because this collides with the previous way, the theme expected author information, it now adheres to Hugo standards and prints out a warning during built if something is wrong.

  Change your previous setting from

  [params]
    author = "Hugo"

  to

  [params]
    author.name = "Hugo"

• Change Taxonomy term pages now add the breadcrumb for each listed page. If this gets too crowded for you, you can turn the breadcrumbs off in your hugo.toml by adding disableTermBreadcrumbs=true.

• New Taxonomy and term pages are now allowed to contain content. This is added inbetween the title and the page list.

• New It is now possible to print custom taxonomies anywhere in your page. See the docs.

• New It is now possible to adjust the menu width for your whole site. See the docs.

• New This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. See the docs.

• New This release comes with additional sort options for the menu and the children shortcode. Both will now accept the following values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adhering to Hugo’s default sort order).

• New The theme now provides a mechanism to load further JavaScript dependencies defined by you only if it is needed. This comes in handy if you want to add own shortcodes that depend on additional JavaScript code to be loaded. See the docs.

• New The theme has updated its Mermaid dependency to 10.6.0. This adds support for the xychart type.

• New This release adds portable Markdown links.

  Previously it was not possible to use pure Markdown links in a configuration independend way to link to pages inside of your project. It always required you to know how your uglyURLs setting is, wheather you link to a page or page bundle and in case of relative links if your current page is a page or page bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This is a hassle as you have to change these links manually once you change your uglyURLs setting or change the type of a page.

  You could work around this by using the relref shortcode (eg [generator]({{% relref "../generator" %}})) which works but results in non-portable Markdown.

  Now it’s possible to use the same path of a call to relref in a plain Markdown link (eg [generator](../generator)). This is independend of any configuration settings or the page types involved in linking. Note, that this requires your links to be given without any extension, so [generator](generator/index.html) will work as before.

  The following types of linking are supported:

  link	description
  [generator](en/basics/generator)	absolute from your project root (multilang)
  [generator](/en/basics/generator)	absolute from your project root (multilang)
  [generator](basics/generator)	absolute from your current language root
  [generator](/basics/generator)	absolute from your current language root
  [generator](./../generator)	relative from the current page
  [generator](../generator)	relative from the current page

5.22.0 (2023-10-02)

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

  If you haven’t modified anything, everything is fine. Otherwise you have to check your custom CSS rules and JavaScript code.

• Change You can now have structural sections in the hierarchical menu without generating a page for it.

  This can come in handy, if content for such a section page doesn’t make much sense to you. See the documentation for how to do this.

  This feature may require you to make changes to your existing installation if you are already using shortcuts to pages inside of your project with a headless branch parent.

  In this case it is advised to remove the title from the headless branch parent’s frontmatter, as it will otherwise appear in your breadcrumbs.

• New It is now possible to overwrite the setting for collapsibleMenu of your hugo.toml inside of a page’s frontmatter.

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

• New It is now possible to remove the root breadcrumb by setting disableRootBreadcrumb=true in your hugo.toml.

• New The output of the dedicated search page now displays the result’s breadcrumb.

• New Table rows now change their background color on every even row.

• New Translation into Swahili. This language is not supported for search.

5.21.0 (2023-09-18)

• Change 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 menu-footer.html partial overridden, you may want to review the styling (eg. margins/paddings) of your partial.

• New 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 the documentation for further details.

• New The theme has updated its Swagger dependency to 5.7.2 for the openapi shortcode. This brings support for OpenAPI Specification 3.1.

5.20.0 (2023-08-26)

• Change The theme has updated its Swagger dependency to 5.4.1 for the openapi shortcode.

  With this comes a change in the light theme variants of Relearn Bright, Relearn Light and Zen Light 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.

  Additionally, the syntaxhighlightning inside of openapi for printing was switched to a light scheme for all theme variants.

  If you dislike this change, you can revert this in your theme variants CSS by adding

  --OPENAPI-CODE-theme: obsidian;
  --PRINT-OPENAPI-CODE-theme: obsidian;

• Change For consistency reasons, we renamed the CSS variable --MENU-SECTION-HR-color to --MENU-SECTION-SEPARATOR-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.

• New The theme variants Zen Light and Zen Dark now add more contrast between menu, topbar and content by adding thin borders.

  Those borders are now configurable by using the CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color and --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.

  For existing variants nothing has changed visually.

• New The default values for the image effects are now configurable for your whole site via hugo.toml or for each page thru frontmatter.

• New This release fixes a long outstanding bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed expand or inactive tabs.

• New Restored compatibility with Hugo versions lower than 0.111.0 for the highlight shortcode. This does not change the minimum required Hugo version.

5.19.0 (2023-08-12)

• New The highlight shortcode now accepts the new parameter title. This displays the code like a single tab. This is also available using codefences and makes it much easier to write nicer code samples.

• New The theme has added two new color variants zen-light and zen-dark. Check it out!

• New The theme now dispatches the custom event themeVariantLoaded on the document when the variant is fully loaded either initially or by switching the variant manually with the variant selector.

• New The theme has updated its Mermaid dependency to 10.3.1. This adds support for the sankey diagram type and now comes with full support for YAML inside Mermaid graphs (previously, the theme ignored explicit Mermaid theme settings in YAML).

• New Translation into Hungarian.

5.18.0 (2023-07-27)

• Change The theme adds additional warnings for deprecated or now unsupported features.

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

• New Restored compatibility with Hugo 0.95.0 or higher. This does not change the minimum required Hugo version.

• New The siteparam shortcode is now capable in displaying nested params aswell as supporting text formatting.

5.17.0 (2023-06-22)

• Change The default behavior for the copy-to-clipboard feature for code blocks has changed.

  The copy-to-clipboard button for code blocks will now only be displayed if the reader hovers the code block.

  If you dislike this new behavior you can turn it off and revert to the old behavior by adding [params] disableHoverBlockCopyToClipBoard=true to your hugo.toml.

• New Restored compatibility with Hugo 0.114.0 or higher. This does not change the minimum required Hugo version.

• New The new highlight shortcode replaces Hugo’s default implementation and is fully compatible. So you don’t need to change anything.

  In addition it offers some extensions. Currently only the wrap extension option is provided to control whether a code block should be wrapped or scrolled if to long to fit.

5.16.0 (2023-06-10)

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

  DEPRECATION warnings mark features that still work but may be removed in the future.

  UNSUPPORTED warnings mark features that will not work anymore.

• Change The 404 error page was revamped. Hopefully you will not see this very often.

• New The tabs shortcode and the tab shortcode received some love and now align with their style, color, title and icon parameter to the other shortcodes.

  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.

  Additionally the name parameter was renamed to title 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.

• New The theme now optionally supports separate favicons for light & dark mode.

5.15.0 (2023-05-29)

• Change Restored compatibility with Hugo 0.112.0 or higher. This does not change the minimum required Hugo version.

  The attachments shortcode has compatiblity issues with newer Hugo versions. You must switch to leaf bundles or are locked to Hugo < 0.112.0 for now.

  It is planned to refactor the attchments 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.

• Change The tabs shortcode has changed behavior if you haven’t set the groupid parameter.

  Formerly all tab views without a groupid were treated as so they belong to the same group. Now, each tab view is treated as it was given a unique id.

• New The already known tabshas a new friend the tab shortcode 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.

  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.

• New Besides the tag taxonomy the theme now also provides the category taxonomy out of the box and shows them in the content footer of each page.

5.14.0 (2023-05-20)

• New The taxonomy pages received some love in this release, making them better leverage available screen space and adding translation support for the taxonomy names.

  Hugo’s default taxonmies tags and categories 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 hugo.toml.

• New To give you more flexibility in customizing your article layout a new partial content-header.html is introduced.

  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 taxonomies not supported by the theme natively. While Hugo supports tags and categories by default, the theme only displays tags.

  So how to adjust the position of tags starting from the theme’s default where tags are only shown above the title?

  1. Hide tags above title: Overwrite content-header.html with an empty file.
  2. Show tags between title and content: Overwrite heading-post.html and add {{- partial "tags.html" . }} to it.
  3. Show tags below content: Overwrite content-footer.html and add {{- partial "tags.html" . }} to it.

• New The new parameter breadcrumbSeparator is now available in your hugo.toml to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything.

5.13.0 (2023-05-17)

• Change The swagger shortcode was deprecated in favor for the openapi shortcode. You don’t need to change anything yet as the old name will be used as a fallback. It is planned to remove the swagger shortcode in the next major release.

  Additionally, the implemantion of this shortcode was switched from RapiDoc to SwaggerUI.

5.12.0 (2023-05-04)

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

• New Support for the great VSCode Front Matter extension which provides on-premise CMS capabilties to Hugo.

  The theme provides Front Matter snippets for its shortcodes. Currently only English and German is supported. Put a reference into your frontmatter.json like this

  {
    ...
    "frontMatter.extends": [
        "./vscode-frontmatter/snippets.en.json"
    ]
    ...
  }

• New 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 pirate translation. This feature is not available in Internet Explorer 11.

• New The scrollbars are now colored according to their variant color scheme to better fit into the visuals.

5.11.0 (2023-02-07)

• 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}}" 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 hugo.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 into 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)

• Breaking With this version it is now possible to not only have sections on the first menu level but also pages.

  It was later discovered, that this causes pages only meant to be displayed in the More section of the menu and stored directly inside your content directory to now show up in the menu aswell.

  To get rid of this undesired behavior you have two choices:

  1. Make the page file a headless branch bundle (contained in its own subdirectory and called _index.md) and add the following frontmatter configuration to the file (see exampleSite’s content/showcase/_index.en.md). This causes its content to not be ontained in the sitemap.

     title = "Showcase"
     [_build]
       render = "always"
       list = "never"
       publishResources = true

  2. Store the page file for below a parent headless branch bundle and add the following frontmatter to he parent (see exampleSite’s content/more/_index.en.md).

     # 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
     [_build]
       render = "never"
       list = "never"
       publishResources = false

     In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s content/more/credits.en.md). This causes its content to be contained in the sitemap.

     title = "Credits"

• 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 hugo.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 hugo.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 hugo.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 hugo.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 hugo.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 into 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 hugo.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 hugo.tomlto:

  [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 hugo.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 and will point to the project’s homepage. If you want to support a different link, overwrite the logo.html partial.

• 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 into 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 hugo.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 hugo.toml to add the capability to print whole chapters or even the complete site.

• New Translation into 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 hugo.toml. If you still want to use the Learn color variant, you have to explicitly set themeVariant="learn" in your hugo.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 hugo.toml. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer. See the documentation for configuration.

  Note, that the new variant selector will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant selector 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. Start up a text editor with regular expression support for search and replace. Search for (ref\s+"[^"]*?)(?:/_index|/index)?(?:\.md)?(#[^"]*?)?" and replace it by $1$2" in all *.md files. This is the recommended choice.

  2. 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.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 hugo.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 hugo.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 no language was given or the language is unsupported. 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 hugo.toml.

• New You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your hugo.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 hugo.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 hugo.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 hugo.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.112.4 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 (hugo.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.

Configuration

On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your hugo.toml. The defaults are written in the comments of each option.

Note that some of these options are explained in detail in other sections of this documentation.

[params]
# If an option value is said to be not set, you can achieve the same behavior
# by given it an empty string value.

###############################################################################
# Hugo
# These options usually apply to other themes aswell.

# The author of your site.
# Default: not set
# This will be used in HTML meta tags, the opengraph protocol and twitter
# cards.
# You can also set `author.email` if you want to publish this information.
author.name = "Sören Weber"

# The social media image of your site.
# Default: not set
# This is used for generating social media meta information for the opengraph
# protocol and twitter cards.
# This can be overridden in the page's frontmatter.
images = [ "images/hero.png" ]

# The description of your site.
# Default: not set
# This is used for generating HTML meta tags, social media meta information
# for the opengraph protocol and twitter cards.
# This can be overridden in the page's frontmatter.
description = "Documentation for Hugo Relearn Theme"

# Admin options for social media.
# Default: not set
# Configuration for the Open Graph protocol and Twitter Cards adhere to Hugo's
# implementation. See the Hugo docs for possible values.
social.facebook_admin = ""
social.twitter = ""

###############################################################################
# Relearn Theme
# These options are specific to the Relearn theme.

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Variants
# These options set your color variant.

# Used color variants.
# Default: "auto"
# This sets one or more color variants, available to your readers to choose
# from. You can
# - set a single value eg. "zen-light"
# - an array like [ "neon", "learn" ]
# - an array with options like [ { identifier = "neon" },{ identifier = "learn" } ]
# The last form allows to set further options for each variant.
# The `identifier` is mandatory. You can also set `name` which overrides the
# value displayed in the variant selector.
# If the array has more than one entry, a variant selector
# is shown in the lower part of the menu. The first entry in the array is the
# default variant, used for first time visitors.
# The theme ships with the following variants: "relearn-bright",
# "relearn-light", "relearn-dark", "zen-light", "zen-dark", "neon", "learn",
# "blue", "green", "red". In addition you can use auto mode variants. See the
# docs for a detailed explaination.
# You can also define your own variants. See the docs how this works. Also,
# the docs provide an interactive theme generator to help you with this task.
themeVariant = [
	{ identifier = "relearn-auto",  name = "Relearn Light/Dark", auto = [] },
	{ identifier = "relearn-light"  },
	{ identifier = "relearn-dark"   },
	{ identifier = "relearn-bright" },
	{ identifier = "zen-auto",      name = "Zen Light/Dark", auto = [ "zen-light", "zen-dark" ] },
	{ identifier = "zen-light"      },
	{ identifier = "zen-dark"       },
	{ identifier = "neon"           },
	{ identifier = "learn"          },
	{ identifier = "blue"           },
	{ identifier = "green"          },
	{ identifier = "red"            }
]

# Filename suffix for variant files.
# Default: not set
# The theme modifies the variant stylesheets during build and tries to store
# them with the same file name. In certain installations it was observed, that
# Hugo could not overwrite these files due to permission issues. If you
# experience this, you can first try to set the `--noChmod` option for Hugo.
# If this still doesn't help you can set this option to eg. ".gen". This will
# be used as a suffix for these generated files, causing them to be newly
# created instead of overwriting the existing ones.
themeVariantModifier = ""

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# General
# These options are defining general, non visual behavior.

# Avoid new asset URLs on build.
# Default: false
# By default JavaScript-files and CSS-files get a unique ID on each rebuild.
# This makes sure, the user always has the latest version and not some stale
# copy of his browser cache. Anyways, it can be desireable to turn this
# off in certain circumstances. For example if you have Hugo's dev server
# running. Also some proxies dislike this optimization.
disableAssetsBusting = false

# Avoid generator meta tags.
# Default: false
# Set this to true if you want to disable generation for generator meta tags
# of Hugo and the theme in your HTML head. In tihs case also don't forget to
# set Hugo's disableHugoGeneratorInject=true. Otherwise Hugo will generate a
# meta tag into your home page anyways.
disableGeneratorVersion = false

# Avoid unique IDs.
# Default: false
# In various situations the theme generates non stable unique ids to be used
# in HTML fragment links. This can be undesirable for example when testing
# the output for changes. If you disable the random id generation, the theme
# may not function correctly anymore.
disableRandomIds = false

# Multilanguage content.
# Default: not set
# If your pages contain further languages besides the main one used, add all
# those auxiliary languages here. This will create a search index with
# support for all used languages of your site.
# This is handy for example if you are writing in Spanish but have lots of
# source code on your page which typically uses English terminology.
additionalContentLanguage = [ "en" ]

# Additional code dependencies.
# Default: See hugo.toml of the theme
# The theme provides a mechanism to load further JavaScript and CSS
# dependencies on demand only if they are needed. This comes in handy if you
# want to add own shortcodes that depend on additional code to be loaded.
# See the docs how this works.
# [relearn.dependencies]

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Topbar
# These options modify the topbar appearance.

# Hide the table of contents button.
# Default: false
# If the TOC button is hidden, also the keyboard shortcut is disabled.
# This can be overridden in the page's frontmatter.
disableToc = false

# Hide the breadcrumbs.
# Default: false
# If the breadcrumbs are hidden, the title of the displayed page will still be
# shown in the topbar.
disableBreadcrumb = false

# Hide Next and Previous navigation buttons.
# Default: false
# If the navigation buttons are hidden, also the keyboard shortcuts are
# disabled.
disableNextPrev = false

# The URL prefix to edit a page.
# Default: not set
# If set, an edit button will be shown in the topbar. If the button is hidden,
# also the keyboard shortcuts are disabled. The given URL is prepended to the
# relative file path of a the displayed page. The URL must end with a `/`.
# This is useful if you wnat to give the opportunity for people to create merge
#  request for your content.
editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/"

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Menu
# These options modify the menu apperance.

# Hide the search box.
# Default: false
# If the searc box is sisabled, the search functionality is disabled too.
# This will also cause the keyboard shortcut to be disabled and the dedicated
# search page is not linked although it mighty be configured.
disableSearch = false

# Hide the Home entry.
# Default: false
# If shown, a Home button will appear below the search bar and the main menu.
# It links to your the home page of the current language.
disableLandingPageButton = true

# The order of main menu submenus.
# Default: "weight"
# Submenus can be ordered by "weight", "title", "linktitle", "modifieddate",
# "expirydate", "publishdate", "date", "length" or "default" (adhering to
# Hugo's default sort order). This can be overridden in the pages frontmatter.
ordersectionsby = "weight"

# The initial expand state of submenus.
# Default: not set
# This controls whether submenus will be expanded (true), or collapsed (false)
# in the menu. If not set, the first menu level is set to false, all others
# levels are set to true. This can be overridden in the page's frontmatter.
# If the displayed page has submenus, they will always been displayed expanded
# regardless of this option.
alwaysopen = ""

# Shows expander for submenus.
# Default: false
# If set to true, a submenu in the sidebar will be displayed in a collapsible
# tree view and a clickable expander is set in front of the entry.
# This can be overridden in the page's frontmatter.
collapsibleMenu = true

# Shows checkmarks for visited pages of the main menu.
# Default: false
# This also causes the display of the `Clear History` entry in the lower part
# of the menu to remove all checkmarks. The checkmarks will also been removed
# if you regenerate your site as the ids are not stable.
showVisitedLinks = true

# Hide heading above the shortcut menu.
# Default: false
# The title for the heading can be overwritten in your i18n files. See Hugo's
# documentation how to do this.
disableShortcutsTitle = false

# Hide the language switcher.
# Default: false
# If you have more than one language configured, a language switcher is
# displayed in the lower part of the menu. This opition lets you explicitly
# turn this behavior off.
disableLanguageSwitchingButton = false

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Hidden pages
# These options configure how hidden pages are treated.
# A page flagged as hidden, is only removed from the main menu if you are
# currently not on this page or the hidden page is not part of current page's
# ancestors. For all other functionality in Hugo a hidden page behaves like any
# other page if not otherwise configured.

# Hide hidden pages from search.
# Default: false
# Hides hidden pages from the suggestions of the search box and the dedicated
# search page.
disableSearchHiddenPages = false

# Hide hidden pages for web crawlers.
# Default: false
# Avoids hidden pages from showing up in the sitemap and on Google (et all),
# otherwise they may be indexed by search engines
disableSeoHiddenPages = true

# Hide hidden pages for taxonomies.
# Default: false
# Hides hidden pages from showing up on the taxonomy and terms pages. If this
# reduces term counters to zero, an empty but not linked term page will be
# created anyhow.
disableTagHiddenPages = false

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Content
# These options modify how your content is displayed.

# Title separator.
# Default: "::"
# Changes the title separator used when concatenating the page title with the
# site title. This is consistently used throughout the theme.
titleSeparator = "::"

# Breadcrumb separator.
# Default: ">"
# Changes the breadcrumb separator used in the topbars breadcrumb area and for
# search results and term pages.
breadcrumbSeparator = ">"

# Hide the root breadcrumb.
# Default: false
# The root breadcrumb is usually the home page of your site. Because this is
# always accessible by clicking on the logo, you may want to reduce clutter
# by removing this from your breadcrumb.
disableRootBreadcrumb = true

# Hide breadcrumbs term pages.
# Default: false
# If you have lots of taxonomy terms, the term pages may seem cluttered with
# breadcrumbs to you, so this is the option to turn off breadcrumbs on term
# pages. Only the page title will then be shown on the term pages.
disableTermBreadcrumbs = false

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Highlight
# These options configure how code is displayed.

# Hide copy-to-clipboard for inline code.
# Default: false
# This removes the copy-to-clipboard button from your inline code.
disableInlineCopyToClipBoard = true

# Always show copy-to-clipboard for block code.
# Default: false
# The theme only shows the copy-to-clipboard button if you hover over the code
# block. Set this to true to disable the hover effect and always show the
# button.
disableHoverBlockCopyToClipBoard = false

# Wrap for code blocks.
# Default: true
# By default lines of code blocks wrap around if the line is too long to be
# displayed on screen. If you dislike this behavior, you can reconfigure it
# here.
# Note that lines always wrap in print mode regardless of this option.
# This can be overridden in the page's frontmatter or given as a parameter to
# individual code blocks.
highlightWrap = true

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Images
# These options configure how images are displayed.

# Image effects.
# See the documentation for how you can even add your own arbitrary effects to
# the list.
# All effects can be overridden in the page's frontmatter or thru URL parameter
# given to the image. See the documentation for details.

# Default: false
imageEffects.border = true
# Default: true
imageEffects.lightbox = true
# Default: false
imageEffects.shadow = false

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Links
# These options configure how links are displayed.

# How to open external links.
# Default: "_blank"
# For external links you can define how they are opened in your browser. All
# values for the HTML `target` attribute of the `a` element are allowed. The
# default value opens external links in a separate browser tab. If you want
# to open those links in the same tab, use "_self".
externalLinkTarget = "_blank"

# Generate link URLs the Hugo way.
# Default: false
# If set to true, the theme behaves like a standard Hugo installation and
# appends no index.html to prettyURLs. As a trade off, your build project will
# not be servable from the file system.
disableExplicitIndexURLs = false

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# MathJax
# These options configure how math formulae are displayed.

# Initialization options for MathJax.
# Default: not set
# A JSON value. See the MathJaxdocumentation for possible parameter.
# This can be overridden in the page's frontmatter.
mathJaxInitialize = "{}"

# Only load MathJax if needed.
# Default: true
# If a Math shortcode is found, the option will be ignored and
# MathJax 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 `disableMathJax=false` in your frontmatter to force the library to
# be loaded.
# This can be overridden in the page's frontmatter.
disableMathJax = true

# URL for external MathJax library.
# Default: not set
# Specifies the remote location of the MathJax library. By default the shipped
# version will be used.
# This can be overridden in the page's frontmatter.
customMathJaxURL = "" # "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Mermaid
# These options configure how Mermaid graphs are displayed.

# Make graphs panable and zoomable
# Default: false
# For huge graphs it can be helpful to make them zoomable. Zoomable graphs come
# with a reset button for the zoom.
# This can be overridden in the page's frontmatter or given as a parameter to
# individual graphs.
mermaidZoom = true

# Initialization options for Mermaid.
# Default: not set
# A JSON value. See the Mermaid documentation for possible parameter.
# This can be overridden in the page's frontmatter.
mermaidInitialize = "{ \"securityLevel\": \"loose\" }"

# Only load Mermaid if needed.
# Default: true
# 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.
# This can be overridden in the page's frontmatter.
disableMermaid = true

# URL for external Mermaid library.
# Default: not set
# Specifies the remote location of the Mermaid library. By default the shipped
# version will be used.
# This can be overridden in the page's frontmatter.
customMermaidURL = "" # "https://unpkg.com/mermaid/dist/mermaid.min.js"

#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# OpenApi
# These options configure how OpenAPI specifications are displayed.

# Only load OpenAPI if needed.
# Default: true
# If a OpenAPI shortcode is found, the option will be ignored and
# OpenAPI 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 `disableOpenapi=false` in your frontmatter to force the library to
# be loaded.
# This can be overridden in the page's frontmatter.
disableOpenapi = true

# URL for external OpenAPI library.
# Default: not set
# Specifies the remote location of the OpenAPI library. By default the shipped
# version will be used.
# This can be overridden in the page's frontmatter.
customOpenapiURL = "" # "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"

Branding

The Relearn theme provides configuration options to change your your site’s colors, favicon and logo. This allows you to easily align your site visuals to your desired style. Most of these options are exposed thru so called color variants.

A color variant lets you customize various visual effects of your site like almost any color, used fonts, color schemes of print, syntax highligtning, Mermaid and the OpenAPI shortcode, etc. It contains of a CSS file and optional configuration options in your hugo.toml.

The Relearn theme ships with a wide set of different color variants. You can use them as-is, copy them over and use them as a starting point for your customizations or just create completely new variants unique to your site. The interactive variant generator may help you with this task.

Once configured in your hugo.toml, you can select them with the variant selector at the bottom of the menu.

Change the Variant (Simple)

Single Variant

Set the themeVariant value to the name of your theme file. That’s it! Your site will be displayed in this variant only.

[params]
  themeVariant = "relearn-light"

Multiple Variants

You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.

[params]
  themeVariant = [ "relearn-light", "relearn-dark" ]

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 to become an auto mode variant. That’s it.

You can use the auto value with the single or multiple variants option. If you are using multiple variants, you can drop auto at any position in the option’s array, 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 default to use relearn-light for light mode and relearn-dark for dark mode. These defaults are overwritten by the first two non-auto options of your themeVariant option if present.

In the above example, you would end with red for light mode and the default of relearn-dark for dark mode.

If you don’t like that behavior, you can explicitly set themeVariantAuto. The first entry in the array is the color variant for light mode, the second for dark mode.

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

Change the Favicon

If your favicon is a SVG, PNG or ICO, just drop your image in your site’s static/images/ directory and name it favicon.svg, favicon.png or favicon.ico respectively.

If you want to adjust your favicon according to your OS settings for light/dark mode, add the image files static/images/favicon-light.svg and static/images/favicon-dark.svg to your site’s directory, respectively, corresponding to your file format. In case some of the files are missing, the theme falls back to favicon.svg for each missing file. All supplied favicons must be of the same file format.

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 layouts/partials/favicon.html in your site’s directory and write something like this:

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

Change the Logo

Create a new file in layouts/partials/logo.html of your site. 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!

Syntax Highlightning

If you want to switch the syntax highlighting theme together with your color variant, you need to configure your installation according to Hugo’s documentation and provide a syntax highlighting stylesheet file.

You can use a one of the shipped stylesheet files or use Hugo to generate a file for you. The file must be written to static/css/chroma-<NAME>.css. To use it with your color variant you have to define --CODE-theme: <NAME> in the color variant stylesheet file.

For an example, take a look into theme-relearn-light.css and hugo.toml of the exampleSite.

Change the Variant (Advanced)

The theme offers a new way to configure theme variants and all of the aspects above inside of a single configuration item. This comes with some features previously unsupported.

Like with the multiple variants option, you are defining your theme variants in an array but now not by simple strings but in a table with suboptions.

Again, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.

[params]
  themeVariant = [ "relearn-light", "relearn-dark" ]

you now write it that way:

[params]
  [[params.themeVariant]]
    identifier = "relearn-light"
  [[params.themeVariant]]
    identifier = "relearn-dark"

The identifier option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.

Parameter

Example Configuration of This Site

[params]
  [[params.themeVariant]]
    identifier = "relearn-auto"
    name = "Relearn Light/Dark"
    auto = []
  [[params.themeVariant]]
    identifier = "relearn-light"
  [[params.themeVariant]]
    identifier = "relearn-dark"
  [[params.themeVariant]]
    identifier = "zen-auto"
    name = "Zen Light/Dark"
    auto = [ "zen-light", "zen-dark" ]
  [[params.themeVariant]]
    identifier = "zen-light"
  [[params.themeVariant]]
    identifier = "zen-dark"
  [[params.themeVariant]]
    identifier = "neon"

Modify Shipped Variants

In case you like a shipped variant but only want to tweak some aspects, you have two choices:

1. Copy and change

   You can copy the shipped variant file from the theme’s static/css directory to the site’s static/css directory and either store it with the same name or give it a new name. Edit the settings and save the new file. Afterwards you can use it in your hugo.toml by the choosen name.

2. Create and import

   You can create a new variant file in the site’s static/css directory and give it a new name. Import the shipped variant, add the settings you want to change and save the new file. Afterwards you can use it in your hugo.toml by the choosen name.

   For example, you want to use the relearn-light variant but want to change the syntax highlightning schema to the one used in the neon variant. For that, create a new static/css/theme-my-branding.css in your site’s directory and add the following lines:

   ​

   static/css/theme-my-branding.css

   @import "theme-relearn-light.css";
   
   :root {
     --CODE-theme: neon; /* name of the chroma stylesheet file */
     --CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */
     --CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */
   }

   Afterwards put this in your hugo.toml to use your new variant:

   ​

   hugo.toml

   [params]
     themeVariant = "my-branding"

   In comparison to copy and change, this has the advantage that you profit from any adjustments to the relearn-light variant but keep your modifications.

Customization

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 hugo.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 hugo.toml:

relativeURLs = true

The theme will append an additional index.html to all page 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 hugo.toml

[params]
  disableExplicitIndexURLs = true

Activate search

If not already present, add the following lines in your hugo.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 hugo.toml file. This will cause Hugo to generate a new file http://example.com/mysite/search.html.

[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 hugo.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.

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 the landingPageName for the defined languages:

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

If this option is 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:

Social Media Meta Tags

You can add social media meta tags for the Open Graph protocol and Twitter Cards to your site. These are configured as mentioned in the Hugo docs.

Change the Menu Width

The menu width adjusts automatically for different screen sizes.

The values for the screen width breakpoints aren’t configurable.

If you want to adjust the menu width you can define the following CSS variables in your custom-header.html. Note that --MENU-WIDTH-S doesn’t exist as the menu is always hidden for small screen sizes.

:root {
    --MENU-WIDTH-M: 14.375rem;
    --MENU-WIDTH-L: 18.75rem;
}

Own Shortcodes with JavaScript Dependencies

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.

You can you use this mechanism in your own shortcodes. Say you want to add a shortcode myshortcode that also requires the jquery JavaScript library.

1. Write the shortcode file layouts/shortcodes/myshortcode.html and add the following line

   {{- .Store.Set "hasMyShortcode" true }}

2. Add the following snippet to your hugo.toml

   [params.relearn.dependencies]
     [params.relearn.dependencies.myshortcode]
       name = "MyShortcode"
       location = "footer"

3. Add the dependency loader file layouts/partials/dependencies/myshortcode.html. The loader file will be appended to your header or footer, dependend on the location setting in your hugo.toml.

   <script src="https://www.unpkg.com/jquery/dist/jquery.js"></script>

Character casing is relevant!

• the name setting in your hugo.toml must match the key (that needs to be prefixed with a has) you used for the store in your layouts/shortcodes/myshortcode.html.
• the key on params.relearn.dependencies in your hugo.toml must match the base file name of your loader file.

See the math, mermaid and openapi shortcodes for examples.

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

React to Variant Switches in JavaScript

Once a color variant is fully loaded, either initially or by switching the color variant manually with the variant selector, the custom event themeVariantLoaded on the document will be dispatched. You can add an event listener and react to changes.

document.addEventListener( 'themeVariantLoaded', function( e ){
  console.log( e.detail.variant ); // `relearn-light`
});

Partials

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.html: side-wide configuration to change the pages title headings.
• 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-header.html: header above the title, has a default implementation but you can overwrite it if you don’t like it.
• content-footer.html: footer below the content, has a default implementation but you can overwrite it if you don’t like it.

Stylesheet generator

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

Download variant Reset variant

Download variant Reset variant

Topbar Modification

The theme comes with a reasonably configured topbar.

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.

Areas

The default configuration comes with three predefined areas that may contain an arbitrary set of buttons.

• start: shown between menu and breadcrumb
• end: shown on the opposite breadcrumb side in comparison to the start area
• more: shown when pressing the more button in the topbar

While you can not add additional areas in the topbar, you are free to configure addtional buttons that behave like the more button, providing further user defined areas.

Buttons

The theme ships with the following predefined buttons (from left to right in the screenshot)

• sidebar: opens the sidebar flyout if in mobile layout
• toc: opens the table of contents in an overlay
• edit: browses to the editable page if the editURL parameter is set
• print: browses to the chapters printable page if print support was activated
• prev: browses to the previous page if there is one
• next: browses to the next page if there is one
• more: opens the overlay for the more area

Not all buttons are displayed at every given time. This is configurable (see below if interested).

Redefining Areas

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.

Eg. you can redefine the predefined end area by adding the file layouts/partials/topbar/area/end.html in your installation (not in the theme itself) to remove all but the more button.

The below example sets an explicit value for the onempty parameter, overriding the specific default value for this button (these defaults vary depending on the button). The parameter causes the more button to always be displayed instead of hiding once its content is empty.

{{ partial "topbar/button/more.html" (dict
    "page" .
    "onempty" "disable"
)}}

Defining own Buttons

Button Types

The theme distingushies between two types of buttons:

• button: a clickable button that either browses to another site, triggers a user defined script or opens an overlay containing user defined content
• area-button: the template for the more button, to define your own area overlay buttons

Button Parameter

Screen Widths and Actions

Depending on the screen width you can configure how the button should behave. Screen width is divided into three classes:

• s: (controlled by the onwidths parameter) mobile layout where the menu sidebar is hidden
• m: (controlled by the onwidthm parameter) desktop layout with visible sidebar while the content area width still resizes
• l: (controlled by the onwidthl parameter) desktop layout with visible sidebar once the content area reached its maximum width

For each width class, you can configure one of the following actions:

• show: the button is displayed in its given area
• hide: the button is removed
• area-XXX: the button is moved from its given area into the area XXX; eg. this is used to move buttons to the more area overlay in the mobile layout

Hiding and Disabling Stuff

While hiding a button dependend on the screen size can be configured with the above described hide action, you may want to hide the button on certain other conditions aswell.

For example, the print 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 layouts/partials/topbar/button/print.html).

Another prefered condition for hiding a button is, if the displayed overlay is empty. This is the case for the toc (see layouts/partials/topbar/button/toc.html) aswell as the more button (see layouts/partials/topbar/button/more.html) and controlled by the parameter onempty.

This parameter can have one of the following values:

• disable: the button displayed in disabled state if the overlay is empty
• hide: the button is removed if the overlay is empty

If you want to disable a button containing no overlay, this can be achieved by an empty href parameter. An example can be seen in the prev button (see layouts/partials/topbar/button/prev.html) where the URL for the previous site may be empty.

Reference

Button

Contains the basic button functionality and is used as a base implementation for all other buttons (layouts/partials/topbar/func/button.html).

Call this from your own button templates if you want to implement a button without an overlay like the print button (layouts/partials/topbar/button/print.html) or with an overlay containing arbitrary content like the toc button (layouts/partials/topbar/button/toc.html).

For displaying an area in the button’s overlay, see Area-Button.

Parameter

Area-Button

Contains the basic functionality to display area overlay buttons (layouts/partials/topbar/func/area-button.html).

Call this from your own button templates if you want to implement a button with an area overlay like the more button (layouts/partials/topbar/button/more.html).

Parameter

Predefined Buttons

The predefined buttons by the theme (all other buttons besides the more and toc button in layouts/partials/topbar/button).

Call these from your own redefined area templates if you want to use default button behavior.

The <varying> parameter values are different for each button and configured for standard behavior as seen on this page.

Parameter

Predefined Overlay-Buttons

The predefined buttons by the theme that open an overlay (the more and toc button in layouts/partials/topbar/button).

Call these from your own redefined area templates if you want to use default button behavior utilizing overlay functionality.

The <varying> parameter values are different for each button and configured for standard behavior as seen on this page.

Parameter

History