Icons

This is a Hugo theme component that adds several icon sets to your Hugo website.

Add this module
[[module.imports]]
path = "github.com/davidsneighbour/hugo-icons"
disable = false
ignoreConfig = false
ignoreImports = false
Latest Version (--)
Fix to this version
hugo mod get github.com/davidsneighbour/[email protected]

Available Icon Fonts

Usage

This module adds a content page at http://localhost:1313/dnb/bootstrap-icons/ that shows an overview of all available icons and their code. This module adds a content page at http://localhost:1313/dnb/heroicons/ that shows an overview of all available icons and their code.

Call these icons as partials:

1{{ partialCached "bsicon" "arrow-right" "arrow-right" }}
2{{ partialCached "heroicon" "arrow-right" "arrow-right" }}

Some things you need to know

These are notes about conventions in this README.md. You might want to make yourself acquainted with them if this is your first visit.

The following documentation will refer to all configuration parameters in TOML format and with the assumption of a configuration file for your project at /config.toml. There are various formats of configurations (TOML/YAML/JSON) and multiple locations your configuration can reside (config file or config directory). Note that in the case of a config directory the section headers of all samples need to have the respective section title removed. So [params.dnb.something] will become [dnb.something] if the configuration is done in the file /config/$CONFIGNAME/params.toml.

Installing

First enable modules in your own repository:

1hugo mod init github.com/username/reponame

Then add this module to your required modules in config.toml.

1[module]
2
3[[module.imports]]
4path = "github.com/davidsneighbour/hugo-icons"

The next time you run hugo it will download the latest version of the module.

Updating

1# update this module
2hugo mod get -u github.com/davidsneighbour/hugo-icons
3# update all modules recursively over the whole project
4hugo mod get -u ./...

FAQ