An IndieWeb-friendly custom theme for Hugo
Switch branches/tags
Nothing to show
Clone or download
Latest commit 9853322 Oct 25, 2018

README.md

Indigo Theme

Indigo is a lightweight, responsive, typography-first theme for Hugo, marked up with microformats2 for extra IndieWeb goodness, including IndieAuth.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for setup and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Some portions of the templates use variable rewriting, introduced in Hugo 0.48, so you'll need to make sure you're running at least this version. You can check what version you're running with

$ hugo version

Follow the upgrade instructions on the Hugo website if necessary.

Installing

Follow the theme-installation instructions on the Hugo website; the URL you'll want to use is

https://github.com/AngeloStavrow/indigo.git

Setup

There's a sample config.toml file in the root of the indigo theme directory (config.toml.example); copy it to the root of your Hugo site, and rename it to config.toml after you've made a backup of your current config.toml file (if any).

Set up the parameters in the config file, especially those in the social and params.indieWeb section. Social identifiers that you leave out will not be added to the footer of the site.

You can configure the theme to show info about the author; by default, this information is shown; if you'd prefer to leave it out, set ShowBio to false.

Deployment

You can add a line to your config.toml file to set this theme as the default:

theme = "indigo"

Or, if you use config.yaml:

theme: indigo

Contributing

Please read CONTRIBUTING.md for details on the code of conduct, and the process for submitting pull requests.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

The following open fonts are used in this theme:

Licenses are included in the theme’s static/fonts folder.

Most icons in the social footer are from Font Awesome. Some come directly from the service itself (e.g., Micro.blog and Glitch).