DCgov Guides Template
This repository is at once a skeleton template for DCgov Guides sites and a set of instructions for setting up your own DCgov Guide.
DCgov guides sites are intended for documenting best practice standards (e.g. design, accessibility, analytics, licensing). They may also be used to provide background information on project repositories, but you really should try to do so in your repository's README file. 18F's open source style guide provides excellent advice for making your projects easy to use and understand!
You will need Ruby ( > version 2.0 ). To check
whether it's already installed on a UNIX-like system, open up a terminal
window (e.g. Terminal on OS X) and type
ruby -v at the command prompt. For
example, you should see something similar to the following:
$ ruby -v ruby 2.2.3p173 (2015-08-18 revision 51636) [x86_64-darwin14]
If the version number is less than 2.0, or instead you see something like:
$ ruby -v -bash: ruby: command not found
Then Ruby is not installed, and you should choose one of the installation methods below. The "Installing Ruby" page of the official Ruby language web site explains how to do this in a number of ways across many different systems.
Quickest Ruby install/upgrade for OS X
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
Optional: using a version manager
Whether or not Ruby is already installed, we strongly recommend 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.
To install all of the site's dependencies, run the following commands:
$ gem install bundler $ bundle install
Cloning and serving the Guides Template locally
To create a new guide and serve it locally, where
MY-NEW-GUIDE is the name
of your new repository:
$ git clone https://github.com/DCgov/guides-template.git MY-NEW-GUIDE $ cd MY-NEW-GUIDE $ ./go serve
This will launch a running instance at
Follow the template instructions
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. For more information, see LICENSE.md.