https://github.com/dotboris/hylda

A Hyde inspired theme for Hugo with a splash of colour
https://github.com/dotboris/hylda

blog blog-theme hugo hugo-theme

Last synced: 3 months ago
JSON representation

A Hyde inspired theme for Hugo with a splash of colour

• Host: GitHub
• URL: https://github.com/dotboris/hylda
• Owner: dotboris
• License: mit
• Archived: true
• Created: 2017-04-24T12:16:00.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-07-01T21:33:25.000Z (over 4 years ago)
• Last Synced: 2024-09-19T14:11:06.177Z (4 months ago)
• Topics: blog, blog-theme, hugo, hugo-theme
• Language: CSS
• Homepage:
• Size: 452 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hylda

[![Demo site](https://img.shields.io/badge/demo-site-brightgreen.svg)](https://hylda-theme.netlify.com/)

[![npm version](https://badge.fury.io/js/hugo-hylda.svg)](https://www.npmjs.com/package/hugo-hylda)

[![CircleCI](https://circleci.com/gh/dotboris/hylda.svg?style=svg)](https://circleci.com/gh/dotboris/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

    ```sh

    yarn init

    ```

1.  Add this theme

    ```sh

    yarn add hugo-hylda

    ```

1.  Link the theme in your `themes` folder

    ```sh

    mkdir -p themes

    cd themes

    ln -s ../node_modules/hugo-hylda

    mv hugo-hylda hylda

    cd ..

    ```

1.  Set your theme in `config.toml`

    ```toml

    theme = "hylda"

    ```

## Development

1.  Install dependencies

    ```sh

    yarn

    ```

1.  Start the build

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

    ```sh

    yarn start

    ```

1.  Open 

### Linting

```sh

yarn lint

```

### Icons

We use the [Font Awesome](http://fontawesome.io/) icons.

To use an icon:

1.  Add the icon name to the `icons.txt` file

1.  Include your icon using `{{ partial "icon" "{name}" }}`

## Releasing

1.  Bump version

    ```sh

    yarn version

    ```

1.  Push version bump

    ```sh

    git push --tags origin master

    ```

1.  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) license.

The icons are extracted from [Font Awesome](http://fontawesome.io/). They are

licensed under [SIL OFL 1.1](http://scripts.sil.org/OFL)