Skip to content
A documentation theme ported from Sphinx to Hugo
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
archetypes Add theme codebase Apr 23, 2016
exampleSite
images Add theme codebase Apr 23, 2016
layouts Replace deprecated .Now with now template func Apr 8, 2017
static
LICENSE.md Initial commit Apr 23, 2016
README.md Add Hugo dev version notice to README Apr 23, 2016
theme.toml

README.md

Alabaster

A documentation theme ported from Sphinx to Hugo.

Screenshot

Quick start

Install with git:

git clone git@github.com:digitalcraftsman/hugo-alabaster-theme.git themes/hugo-alabaster-theme

This theme uses the latest developement version of Hugo. Therefore, it doesn't work with the official releases. Look here if you want to know how to build Hugo from source.

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 Alabaster theme should be visible.

For detailed installation instructions visit the demo.

Acknowledgements

Last but not I want to give a big shout-out to Jeff Forcier, Kenneth Reitz and Armin Ronacher. Their work and modifications on the original codebase made this port possible.

Furthermore, thanks to Steve Francia for creating Hugo and the awesome community around the project.

License

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

You can’t perform that action at this time.