What's New

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

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

Version 7

7.0.0 (2024-10-13)

Hugo 0.126.0

  • 0.126.0 This release requires a newer Hugo version.

Breaking

  • Breaking This release comes with significant changes in file naming of partials and how the theme works internally. This was done because the theme

    • suffered from poor build performance for sites with 1000 or more pages
    • reinvented the wheel instead of using available Hugo mechanisms

    What do I gain, you may ask. A significant performance boost during build! Usually, the build time has been cut at least in half for bigger sites. It is now possible to build even larger sites with 5000 or more pages. This was previously almost impossible due to rapidly increasing build time with the more pages you’ve introduced. For even bigger sites, the theme now has configurable performance optimizations - at the price of feature limitations.

    If you haven’t done customizations to any partials, you can update right away.

    If you have customized your templates, in the best cases, you will get build warnings or even errors. In the worst cases, your build succeeds but the site will not work as intended by you.

    Specifically, you will have to adapt your site if you have

  • Breaking This release changes the way the search index and the dedicated search page are generated. This may require reconfiguration by you to still work as you have intended.

    You need to remove the now obsolete search and searchpage output format from [outputs.home] in your hugo.toml, resulting in something similar to

    hugo.
    [outputs]
  home = ['html', 'rss', 'print']
    outputs:
  home:
  - html
  - rss
  - print
    {
   "outputs": {
      "home": [
         "html",
         "rss",
         "print"
      ]
   }
}

    After that, your build will succeed but will most likely cause new defaults to be applied. With no further settings, in-page search, search popup and dedicated search page are all active by default. This can be reconfigured.

    In addition, you are now able to overwrite the default file name of the search index and the default page name of the dedicated search page by changing searchIndexURL and searchPageURL respectively in your hugo.toml.

    See the updated documentation for reference.

Change

  • Change Once again, the theme changed the font. We switched to the excellent Roboto Flex font.

    Care was taken to configure the font to look similar to the previously used Work Sans. Nevertheless, in direct comparison, you will see slight differences in appearance.

    This change was necessary as the previously used font had display issues with marked text, contrast, and some other minor stuff. As an aftermath, the number of requests and the download size were decreased when loading a page.

    The font was created by Google, is licensed under OFL 1.1 and is delivered from your theme’s installation. As always, no third-party server calls are involved.

    If you have changed the font-family in your installation, you most likely have to adjust the variables --MAIN-font-weight, --MAIN-BOLD-font-weight and --MAIN-letter-spacing.

    Additionally, if you have changed the font to a variable font in your installation, you may have to adjust the variable --MAIN-font-variation-settings. As this only applies to variable fonts, this should rarely be necessary.

  • Change While switching the font, it was discovered that certain CSS variables were falsely named. You don’t need to change anything in your custom variant stylesheet as the old names will be used as a fallback.

    --MAIN-TITLES-TEXT-font was renamed to --MAIN-TITLES-font, --MAIN-TITLES-H<n>-color was renamed to --MAIN-TITLES-H<n>-TEXT-color.

  • Change The options and front matter to force loading a math, mermaid or openapi library has been changed.

    Previously, you had to set the unintuitive disableMathJax=false to force load the math library in case of a passthrough configuration. This is replaced by the simpler math=true or math.force=true and is now in line with Hugo’s official documentation.

    You don’t need to change anything yet but will receive warnings if the old settings are used.

  • Change The default logo is not contained inside of the theme’s logo partial anymore.

    This is to avoid usage of the theme’s branding throughout the web in non-modified installations.

    In addition, the default text for the logo partial is now taken from the linkTitle setting of your hugo.toml.

New

Version 6

6.4.0 (2024-10-11)

Change

New

  • New It is now possible to have user-defined styles for all shortcodes that accept the style parameter. See the notice shortcode for configuration.

  • New The resources shortcode has a new parameter expanded to make the resource list collapsible.

6.3.0 (2024-09-03)

Change

  • Change The expand shortcode changed the naming of the open parameter to expanded. You don’t need to change anything yet but may get deprecation warnings.

  • Change If the content for the notice shortcode is empty, now only the title bar will be displayed. Previously an empty content box was displayed.

New

  • New The notice shortcode has a new parameter expanded to make the content collapsible.

  • New If you are running Hugo 0.134.0 or later, the theme now supports Obsidian callouts.

  • New The theme has updated its Mermaid dependency to 11.1.0. This adds support for packet and architecture diagrams.

6.2.0 (2024-08-26)

Change

  • Change The heading anchor links are extended in functionality.

    If you now click on it, not only is the link copied to the clipboard (previous behavior) but also the heading scrolls to the top of the page.

    If you dislike the new behavior, you can deactivate it by setting disableAnchorScrolling=true in your hugo.toml. See the docs for further options.

New

  • New If you are running Hugo 0.132.0 or later, the theme is now capable to print GitHub alerts.

  • New To support new severity levels for GitHub alerts, all shortcodes that support severity levels with their style parameter were expanded with the new severities caution and important and the color parameter was expanded with cyan and magenta. Please note, that coloring and icons of severities may defer from the display you see on GitHub.

  • New To support new severity levels for GitHub alerts, the new severities and their according colors are also available as CSS variables BOX-MAGENTA-color, BOX-MAGENTA-TEXT-color, BOX-CAUTION-color, BOX-CAUTION-TEXT-color, BOX-CYAN-color, BOX-CYAN-TEXT-color, BOX-IMPORTANT-color, BOX-IMPORTANT-TEXT-color. You don’t need to change anything in your custom color stylesheet as appropriate default colors will be used.

6.1.0 (2024-08-02)

Change

  • Change The include shortcode is now able to resolve links to pages as well as resources or files in the file system (the old behavior).

  • Change To make the asset buster mechanism more robust, some internally used stylesheets where restructured. This generally should not affect your page in any negative way.

New

  • New The openapi shortcode is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting openapi.errorlevel to either warning or error in your hugo.toml if a path can not be resolved.

  • New Shortcodes supporting an errorlevel configuration can now have overridden values in the front matter section of each individual page.

  • New The theme now comes with its own overridden version of the relref shortcode.

    While the usage of relref is obsolete and discouraged by Hugo for a while, existing installations may use it. In configurations using a baseURL with a subdirectory, and having relativeURLs=false (the default) Hugo’s standard relref implementation was failing.

    The shortcode is deactivated by default and can be activated by setting

    hugo.
    [params]
  disableDefaultRelref = true
    params:
  disableDefaultRelref: true
    {
   "params": {
      "disableDefaultRelref": true
   }
}

    in your hugo.toml. Only do this if your site fulfills all of the above assumptions.

6.0.0 (2024-04-27)

Breaking

  • Breaking This release requires you to move your self-defined variant (theme-*.css) and chroma stylesheets (chroma-*.css) from static/css to assets/css.

    This was necessary to avoid permission errors on build if running in certain Unix configurations.

    In addition it is not allowed anymore to @import your chroma stylesheet from inside of your variant stylesheet.

    Say, your chroma stylesheet is named chroma-monokai.css, you have to add the following inside your variant stylesheet:

    --CODE-theme: monokai;

  • Breaking The parameter description in your hugo.toml will now be ignored.

    With the newly introduced unified handling of descriptions throughout the theme, the only place the old parameter would have been used was your home page.

    For migration, move the description parameter of your hugo.toml into the front matter section of your home page.

  • Breaking Search support for the json outputformat deprecated in 5.4.0 was removed.

    Change it to search for the homepage in your hugo.toml. See the docs for detailed configuration.

  • Breaking The front matter option menuTitle deprecated in 5.24.0 was removed in favor for Hugo’s own linkTitle.

    Additionally, if set, linkTitle will now be used instead of title to generate the breadcrumb.

  • Breaking The swagger shortcode deprecated in 5.13.0 was removed in favor for the openapi shortcode with the same set of parameter.

  • Breaking Support for Internet Explorer 11 was finally dropped.

Change

  • Change With the removal of support for Internet Explorer 11, Font Awesome was upgraded to version 6.5.2.

    You may experience slight changes for some icons. In addition you have additional ~1700 icons to chose from.

  • Change The children shortcode was fixed to adhere to its documentation, generating the description based on this rule: When no description or summary exists for the page, the first 70 words of the content is taken.

    Previously, the summary erroneously was ignored which now can lead to different output if you set description=true as a parameter.

New

  • New The include shortcode is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting include.errorlevel to either warning or error in your hugo.toml if a path can not be resolved.

  • New Math is now usable without enclosing it in a shortcode or Markdown codefence by using Hugo’s passthrough configuration.

  • New Translation into Romanian.

Older Versions