Hinode Module - FlexSearch

About

Hinode is a clean blog theme for Hugo, an open-source static site generator. Hinode is available as a template, and a main theme. This repository maintains a Hugo module to add FlexSearch to a Hinode site. Visit the Hinode documentation site for installation instructions.

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

This module supports the following parameters (see the section params.modules in config.toml):

| Setting | Default | Description | |-------------------------|----------|-------------| | flexsearch.canonifyURLs | false | If set, uses absolute URLs for the indexed pages instead of relative URLs. | | flexsearch.frontmatter | false | If set, includes front matter in the page content. The search index function adds all parameters with the name content, heading, title, preheading recursively. | | flexsearch.filter | "params" | Restricts the scanned frontmatter variables to the named filter. By default, all front matter variables are scanned. Only applicable when flexsearch.frontmatter is set. |