Hugo Onyx Theme screenshot

Hugo Onyx Theme

Author Avatar Theme by Kaushalmodi
Updated: 6 Apr 2022
28 Stars

A Hugo theme built using the Hugo Alabaster theme as base

Overview

Onyx is a documentation theme that is a fork of Hugo’s Alabaster theme. It is an indirect port of Sphinx. The theme requires the latest version of Go to be installed.

Features

  • Forked from Hugo’s Alabaster theme
  • Indirect port of Sphinx
  • Requires the latest version of Go to be installed

Installation

To install the Onyx theme, follow these steps:

  1. Install the latest version of Go from https://go.dev/doc/install.
  2. Run the following command in your main site directory: hugo mod tidy.
  3. Add the following code to your site’s TOML config file:
[module]
[[module.imports]]
path = "github.com/hugo-onyx-theme"
  1. Run the following command in your main site directory: hugo mod tidy.

Summary

Onyx is a documentation theme that is based on Hugo’s Alabaster theme. It is an indirect port of Sphinx and requires the latest version of Go to be installed. The theme is composed of the base theme “hugo-onyx-theme” and the “hugo-debugprint” component. Onyx is released under the BSD license.