Onyx

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

Requirements

You need to install the latest version of Go from https://go.dev/doc/install because this theme component requires hugo mod .. commands to work.

This update on switch to using Hugo Modules was last tested with Hugo v0.92.0.

Installing this theme

To use this component,

1. Add this to your site's TOML config file:

   [module]
     [[module.imports]]
       path = "github.com/kaushalmodi/hugo-onyx-theme"

2. Run hugo mod tidy in your main site directory.

Theme components

This theme is composed of the base theme "hugo-onyx-theme", and the "hugo-debugprint" component (which gets auto-fetched using hugo mod).

Alabaster screenshot

Demo

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.