GOV.UK Developer Docs
This is a static site generated with Middleman.
Tech docs template
This project uses alphagov/tech-docs-template.
managed in the template and are not supposed to be modified here. Any project-specific
Ruby code needs to go into
You can pull down the latest version of the template by running:
The first time you'll need to bundle:
To run the app locally:
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:
It doesn't need any permissions.
Use it like this:
export GITHUB_TOKEN=somethingsomething ./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
This project is re-deployed by a Jenkins task every hour (to pick up external changes). It is hosted on S3.
There are pre-commit hooks available to help when creating or editing markdown.
brew install pre-commit
pip install pre-commit
Install vale linter:
brew tap ValeLint/vale
brew install vale
Install the binary:
Download the latest release.
tar zxvf vale_0.9.0_Linux_64-bit.tar.gz
chmod +x vale && mv vale /usr/local/bin/vale