18F Documentation Working Group
This is the repository for the 18F Documentation Working Group.
Generating the site/hosting locally
On OS X, you can use Homebrew to install Ruby in
/usr/local/bin, which may require you to update your
$ brew update $ brew install ruby
To serve the site locally:
$ git clone firstname.lastname@example.org:18F/wg-documentation.git $ cd wg-documentation $ ./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/wg-documentation/. (Make sure to include the trailing
slash! The built-in Jekyll webserver doesn't redirect to it.)
After going through these steps, run
./go to see a list of available
serve command is the most common for routine development.
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.