mr8nd / hugo-onyx-theme

A Hugo theme built using the Hugo Alabaster theme as base

Onyx

A documentation theme forked from Hugo Alabaster theme. It is an indirect port of Sphinx.

Theme components

This theme is composed of the base theme "hugo-onyx-theme", and the "hugo-search-fuse-js" component.

To use this theme, you need to clone this theme and the component(s) too:

cd HUGO_SITE_DIR/themes
git clone https://github.com/kaushalmodi/hugo-onyx-theme
git clone https://github.com/kaushalmodi/hugo-search-fuse-js

Do not change the cloned repo directory names.

Alabaster screenshot

Quick start

Install with git:

cd /to/your/hugo/site/repo/root
git clone https://github.com/kaushalmodi/hugo-onyx-theme themes/hugo-onyx-theme

Next, take a look in the exampleSite folder at. This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation.

Copy at least the config.toml in the root directory of your website. Overwrite the existing config file if necessary.

Hugo includes a development server, so you can view your changes as you go - very handy. Spin it up with the following command:

hugo server

Now you can go to localhost:1313 and the Onyx theme generated site should be visible.

Demo

Acknowledgements

I want to give a big shout-out to Digitalcraftsman, and also to the original theme (from which the Alabaster theme was ported) authors Jeff Forcier, Kenneth Reitz and Armin Ronacher.

Furthermore, thanks to Steve Francia for creating Hugo, Bjørn Erik Pedersen for leading the current Hugo development, and the awesome community around the project.

License

The theme is released under the BSD license. Read the license for more information.