Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.95 KB

README.md

File metadata and controls

59 lines (40 loc) · 2.95 KB
Raw

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.

Running the site with Docker

If you don't want to deal with making sure you have the proper versions of Ruby and Node installed, you can run it with Docker instead:

  1. Install Docker Community Edition.
  2. Clone the repository.
  3. Run docker-compose up.
  4. Visit the local site at http://localhost:4000

If you decide that you no longer want to run the site using Docker, run docker-compose down -v to properly clean everything up.

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.