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.
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:
Now you can go to
localhost:1313 and the Onyx theme generated site should be
The theme is released under the BSD license. Read the license for more information.