Heron Documentation

Heron's documentation was primarily built using the following components:

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

Documentation Setup

Running the Heron documentation locally requires that you have the following installed:

OS X Setup

To install Node.js and npm on Mac OS X, make sure that you have Homebrew installed and run:

$ brew install nvm
$ nvm install node

Once this has completed:

# Within the /heron directory
$ cd website
$ make setup

This will install Hugo, Gulp, and all of the necessary Gulp plugins and build the static assets for the site.

Other Operating Systems

Although the documentation is currently set up to be built and run on OS X, it's also possible to do so on other systems. In addition to Node.js and npm you will also need to install Hugo. Once those are installed:

Navigate to the website folder
Run npm install gulp
Run gulp build (this will build all of the necessary static assets, i.e. CSS, Javascript, etc.)

Now you can run the docs locally. For more info, see the section directly below.

Building the Docs Locally

To build the docs:

$ make site

This will generate a full build of the docs in the public folder. To serve the docs locally, see the section directly below.

Running the Docs Locally

$ make serve

This will run the docs locally on localhost port 1313. Navigate to localhost:1313/heron in your browser to see the served docs. Or open the browser from the command line:

$ open http://localhost:1313/heron

To make site, including linkchecker. If broken links found by linkchecker, see linkchecker-errors.csv

$ make site