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. Any project-specific Ruby code needs to go into /app.

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

If you have issues installing mimemagic, you may need to brew install shared-mime-info.

To run the app locally:

./startup.sh

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

GitHub token

You will need a GitHub auth token to build the project or run the full test suite, otherwise you will 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

You may find it easier to save the token to a file and then refer to it dynamically:

GITHUB_TOKEN=$(cat ~/github_token.txt) ./startup.sh

Building the project

Build the site with:

NO_CONTRACTS=true bundle exec middleman build

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

Testing

bundle exec rake

Deployment

This project is hosted on GitHub Pages. It is redeployed hourly on weekdays (to pick up changes to external docs) and whenever a PR is merged.

Licence

MIT License