18F Guides Template

This is a skeleton repo containing the CFPB/DOCter-based Jekyll template for 18F Guides.

Generating the site/hosting locally

You will need Ruby ( > version 2.1.5 ). You may consider using a Ruby version manager such as rbenv or rvm to help ensure that Ruby version upgrades don't mean all your gems will need to be rebuilt.

On OS X, you can use Homebrew to install Ruby in /usr/local/bin, which may require you to update your $PATH environment variable:

$ brew update
$ brew install ruby

To create a new guide and serve it locally, where MY-NEW-GUIDE is the name of your new repository:

$ git clone git@github.com:18F/guides-template.git MY-NEW-GUIDE
$ cd MY-NEW-GUIDE
$ ./go init
$ ./go serve

This will check that your Ruby version is supported, install the Bundler gem if it is not yet installed, install all the gems needed by the template, and launch a running instance on http://localhost:4000/guide/. (Make sure to include the trailing slash! The built-in Jekyll webserver doesn't redirect to it.) That page contains further instructions on how to adapt the template to a new guide repository.

After going through these steps, run ./go to see a list of available commands. The serve command is the most common for routine development.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.