18F Content Guide
Clone or download
Latest commit 3f84d9f Aug 27, 2018
Permalink
Failed to load latest commit information.
.circleci Add npm and gem install steps to Circle CI config. Sep 22, 2017
_includes Minimum-viable print (#205) Feb 9, 2018
_layouts Work in progress Aug 5, 2016
_pages Add guidance for user-centered over human-centered Jun 7, 2018
assets/css Move betaFEC.png to images/. Sep 23, 2016
images Move betaFEC.png to images/. Sep 23, 2016
javascripts Tweak JS for omitting certain header elemenst from AnchorJS functiona… Nov 21, 2016
stylesheets Minimum-viable print (#205) Feb 9, 2018
.gitignore initial commit Jul 1, 2015
.travis.yml More Travis CI testing Sep 7, 2016
CONTRIBUTING.md Rename contributing.md to CONTRIBUTING.md Nov 1, 2016
Dockerfile Update README.md install instructions, add Docker support. Jul 14, 2017
Gemfile Switch to combined Ruby plus Node docker image, upgrade some dependen… Sep 22, 2017
Gemfile.lock Switch to combined Ruby plus Node docker image, upgrade some dependen… Sep 22, 2017
LICENSE.md Add notes to license file about inclusion of Anchor JS and jQuery. Nov 8, 2016
README.md Remove Docker instructions Aug 13, 2018
_config.yml Merge pull request #207 from 18F/style-guides Jan 4, 2018
docker-compose.yml Fix conflict in docker-compose.yml. Sep 22, 2017
favicon-16x16.png Work in progress Aug 5, 2016
favicon-32x32.png Work in progress Aug 5, 2016
favicon.ico Work in progress Aug 5, 2016
favicon.png initial commit Jul 1, 2015
go Switch to combined Ruby plus Node docker image, upgrade some dependen… Sep 22, 2017
nav-tips.md Add logo, nav-tips. Update footer. Aug 31, 2016

README.md

18F Content Guide

This is the repository for the 18F Content Guide. This guide was developed for 18F employees, but we hope it's a useful reference for everyone.

For a detailed introduction, see how to use this guide.

History

18F's Content Guild (#g-content) maintains this guide.

We started by adapting GOV.UK’s work, and we’d like to thank their team for championing plain language and information accessibility. We've since expanded the guide to cover more topics, reorganized things, and moved the site from 18F Pages to Federalist. This guide is a work in progress, and we'll continue refining it over time.

Contributors

Running the site

The 18F Content Guide runs on Jekyll.

To run it locally:

  1. Make sure that you have Ruby 2.3. At present, this project is incompatible with Ruby 2.4.
  2. Clone the repository.
  3. Install Jekyll and the necessary dependencies: bundle install
  4. Run the web server with ./go serve (or jekyll serve if you have Jekyll installed globally)
  5. Visit the local site at http://localhost:4000

Note that you will also need Node.js in order for the site's built-in search functionality to work.

Public domain

As a work of the United States government, this project is in the public domain within the United States.

Additionally, we waive copyright and related rights in the work worldwide through the CC0 1.0 Universal public domain dedication.