Documentation for developers working on GOV.UK
CSS HTML Ruby JavaScript Shell
Latest commit 8e40ccf Feb 20, 2017 @tijmenb tijmenb committed on GitHub Merge pull request #54 from alphagov/add-taxonomy-tree
Add link to the taxonomy tree search

README.md

GOV.UK Developer Docs

👉 https://docs.publishing.service.gov.uk

Technical documentation

This is a static site generated with Middleman.

Tech docs template

This project uses alphagov/tech-docs-template.

This means that some of the files (like the CSS, javascripts and layouts) are managed in the template and are not supposed to be modified here.

You can pull down the latest version of the template by running:

bin/update

Dependencies

  • Ruby

Running locally

The first time you'll need to bundle:

bundle install

To run the app locally:

./startup.sh

The app will appear at http://localhost:4567/

You may need a GitHub auth token if you find yourself rate limited. You can create one here:

https://github.com/settings/tokens/new

It doesn't need any permissions.

Use it like this:

export GITHUB_TOKEN=somethingsomething
./startup.sh

Building the project

Build the site with:

bundle exec middleman build

This will create a bunch of static files in /build.

Deployment

This project is re-deployed by a Jenkins task every hour (to pick up external changes). It is hosted on S3.

Licence

MIT License