Skip to content
This repository was archived by the owner on Jun 11, 2018. It is now read-only.

Latest commit

 

History

History
59 lines (34 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

59 lines (34 loc) · 1.37 KB

Contributing

Development Setup

This website is built using the Jekyll static site generator. As such, you must install a number of prerequisites in order to actively contribute to this repo:

  1. [Mac OSX only] Ensure you have the XCode Developer Command Line Tools installed:

    xcode-select --install
  2. Ensure you have a version of Ruby >= 2.0.0 installed:

    ruby --version

    If not, fix that!

  3. Ensure you have Bundler installed:

    gem install bundler
  4. Ensure you have Jekyll (Jekyll for GitHub Pages, technically) installed:

    bundle install

Development Workflow

You can build and serve the site by executing the following command:

bundle exec jekyll serve

Optionally, if you want Jekyll to monitor your pages' source files and automatically rebuild them on the fly if they change, you can add the --watch flag:

bundle exec jekyll serve --watch

More Information

For further info on this workflow, use the following resources: