REVSYS Docs Cookiecutter

This is our cookiecutter for generating REVSYS themed documentation using hugo.

NOTE: This cookiecutter is primarily used by our rsdoc utility

Install hugo

You need to make sure hugo is installed, which for OSX is just:

brew update
brew install hugo

Quickstart

Run the cookiecutter:

cookiecutter https://github.com/revsys/revsys-doc-cookiecutter

If you used the defaults, it will create the scaffolding in ./docs/ and then all you need to do is:

cd docs
hugo server

And begin editing your content.

Generating a static site version

To generate your docs into a static site just run:

hugo

And it will build it into ./public/

Questions?

If you have a question about this project, please open a GitHub issue. If you love us and want to keep track of our goings-on, here's where you can find us online: