Guide to the Heron Documentation

Heron's documentation was built using the following components:

• Hugo --- Static site generator
• GulpJS --- Build tool for static assets
• Twitter Bootstrap --- CSS and JavaScript

Setup

If you have Homebrew and npm installed:

$ cd /path/to/heron/website
$ make setup

This will install Hugo, Gulp, and all necessary Gulp plugins.

Running the Docs Locally

$ hugo server --watch

This will the docs locally on localhost port 1313.

Working with Static Assets

To build a full static asset distribution (CSS, JavaScript, fonts, and images):

$ gulp build

To work on assets in “watch” mode:

$ gulp dev