Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gethinode/mod-utils

A Hugo module with common utilities for your Hinode site
https://github.com/gethinode/mod-utils

Last synced: 3 months ago
JSON representation

A Hugo module with common utilities for your Hinode site

Awesome Lists containing this project

README

        

# Hinode Module - Utilities


A Hugo module with common utilities for your Hinode site





















## About

![Logo](https://raw.githubusercontent.com/gethinode/hinode/main/static/img/logo.png)

Hinode is a clean blog theme for [Hugo][hugo], an open-source static site generator. Hinode is available as a [template][repository_template], and a [main theme][repository]. This repository maintains a Hugo module that define common utilities compatible with your Hinode site. Visit the Hinode documentation site for [installation instructions][hinode_docs].

## Configuration

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

| Setting | Default | Description |
|-------------------------|---------|-------------|
| utils.filter | `[^0-9A-Za-zŽžÀ-ÿ ;.,\/'’"]` | Defines the regular expression for characters to remove from page descriptions. These page descriptions are used to define card content and metadata for search indexes. Adjust the filter to define which characters to support. You may need to adjust these settings to support specific diacritical letters. |
| utils.raw | false | Flag to indicate page descriptions should be returned as-is. In this setting, the filter is ignored. |

[hugo]: https://gohugo.io
[hinode_docs]: https://gethinode.com

[repository]: https://github.com/gethinode/hinode.git
[repository_template]: https://github.com/gethinode/template.git