Version 2

See the changelog of this version for a detailed list of changes.

  • 0.81.0 Minimum required Hugo version

  • Breaking Change requiring action after upgrade

  • Change Change of behavior, may require action

  • New New behavior, often introducing new options

2.9.0 (2021-11-19)

Breaking

  • Breaking This release removes the themes implementation of ref/relref in favor for Hugo’s 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 configuration/reference/_index.md configuration/reference
    Leaf bundle configuration/reference/index.md configuration/reference
    Page configuration/reference.md configuration/reference

    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 Hugo’s 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 Hugo’s 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 of

    ERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref "configuration/reference/_index.md": "hugo-theme-relearn\docs\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

  • 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

  • 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

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

2.6.0 (2021-10-21)

New

  • New Your site can now be served from a subdirectory if you set baseURL in your hugo.toml. See the documentation for a detailed example.

2.5.0 (2021-10-08)

Change

  • Change New colors --CODE-BLOCK-color and --CODE-BLOCK-BG-color were added to provide a fallback for Hugo’s 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

  • 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

  • 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 front matter 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)

Hugo 0.81.0

  • 0.81.0 This release requires a newer Hugo version.

New

  • 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 Piratish one due to maintenance constraints.

2.2.0 (2021-09-09)

New

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

Hugo 0.69.0

  • 0.69.0 This release requires a newer Hugo version.

Change

  • 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), they will now be ignored by the search.

New

  • 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

  • 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

  • New You can define the expansion state of your menus in the front matter. 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.