hugo-hylda v1.1.5

Hylda

A Hyde inspired theme for Hugo with a splash of colour.

Installation

This theme is distributed through the NPM registry. It's recommended to install it with either npm or yarn.

1. Setup an package.json if you don't already have one

   yarn init

2. Add this theme

   yarn add hugo-hylda

3. Link the theme in your themes folder

   mkdir -p themes
   cd themes
   ln -s ../node_modules/hugo-hylda
   mv hugo-hylda hylda
   cd ..

4. Set your theme in config.toml

   theme = "hylda"

Development

1. Install dependencies

   yarn

2. Start the build

   This will serve the example, build the assets and lint your code

   yarn start

3. Open http://localhost:1313

Linting

yarn lint

Icons

We use the Font Awesome icons.

To use an icon:

1. Add the icon name to the icons.txt file
2. Include your icon using {{ partial "icon" "{name}" }}

Releasing

1. Bump version

   yarn version

2. Push version bump

   git push --tags origin master

3. The CI will publish a new release and version of the demo site for you

License

All the code in this project is licensed under the MIT license.

The icons are extracted from Font Awesome. They are licensed under SIL OFL 1.1