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.
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.
- Jamie Albrecht
- Emileigh Barnes
- Nicole Fenton
- Andre Francisco
- Britta Gustafson
- Jeannine Hunter
- James Hupp
- Andrew Maier
- Corey Mahoney
- Kate Saul
- Anna Heller Sebok
- Will Slack
- Tadhg O'Higgins
- Atul Varma
The 18F Content Guide runs on Jekyll.
To run it locally:
- Make sure that you have Ruby 2.3. At present, this project is incompatible with Ruby 2.4.
- Clone the repository.
- Install Jekyll and the necessary dependencies:
bundle install - Run the web server with
./go serve(orjekyll serveif you have Jekyll installed globally) - 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.
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:
- Install Docker Community Edition.
- Clone the repository.
- Run
docker-compose up. - 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.
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.