Hugo Alabaster Theme screenshot

Hugo Alabaster Theme

Updated: 8 Jun 2020
73 Stars

A documentation theme ported from Sphinx to Hugo

Categories

Overview

The Alabaster theme is a documentation theme that has been ported from Sphinx to Hugo. It is important to note that this theme is no longer being maintained. This theme is compatible with the latest development version of Hugo and may not work with the official releases. The theme is released under the BSD license.

Features

  • Ported from Sphinx to Hugo
  • Compatible with the latest development version of Hugo
  • Example setup provided in the exampleSite folder
  • Easy installation and setup process
  • Development server included for real-time preview of changes
  • BSD license

Installation

To install the Alabaster theme, follow these steps:

  1. Install Hugo development version (official releases may not work with this theme)
  2. Clone the theme repository using the command:
git clone [repository URL]
  1. Navigate to the exampleSite folder in the cloned repository
  2. Copy the config.toml file to the root directory of your website
    • Overwrite the existing config file if necessary
  3. Start the Hugo development server using the command:
hugo server
  1. Open your web browser and go to localhost:1313 to view the Alabaster theme

For detailed installation instructions, please refer to the demo.

Summary

The Alabaster theme is a documentation theme that was originally developed for Sphinx and has been ported to Hugo. It is no longer maintained, but it offers a range of features including compatibility with the latest development version of Hugo, easy installation and setup process, and a built-in development server for real-time preview of changes. The theme is released under the BSD license.