Hinode Module - Compatibility

About

[!CAUTION] Use this module only when using Hinode v0.28.2 or later in combination with Hugo <v0.141.0.

Hinode is a clean blog theme for Hugo, an open-source static site generator. Hinode is available as a template, and a main theme. Hugo v0.141.0 introduced a new try mechanism to improve error handling. This is a breaking change with older Hugo versions.

This module includes several partials and render hooks to improve compatibility with Hinode sites that are still using an older Hugo version. Specifically, this module was introduced to ensure Hinode is compatible with CloudCannon's Bookshop component framework. The embedded Hugo renderer still uses Hugo v0.136.1 under the hood.

Contributing

This module uses semantic-release to automate the release of new versions. The package uses husky and commitlint to ensure commit messages adhere to the Conventional Commits specification. You can run npx git-cz from the terminal to help prepare the commit message.

Configuration

Mount this module last in the site's module configuration to replace Hinode's partials and render hooks that are incompatible with Hugo <v0.141.0. The following module configuration is an example (define the configuration in e.g. hugo.toml).

[module]
  [module.hugoVersion]
    extended = true
    min = "0.120.0"
    max = "0.140.2"
  [[module.imports]]
    path = "github.com/gethinode/hinode"
  [[module.imports]]
    path = "github.com/gethinode/mod-compatibility"