This is a static site generated with Middleman.
Tech docs template
This project uses alphagov/tech-docs-template.
To make changes, edit the source files in the
source directory. To add a
completely new page, create a file with a
.html.md extension in the
Whilst writing documentation we can run a middleman server to preview how the
published version will look in the browser. After saving a change the preview in
the browser will automatically refresh. Run
bundle exec middleman server,
then the website will be available locally at http://localhost:4567.
Building the project
Build the site with:
bundle exec middleman build
This will create a bunch of static files in
This is deployed automatically to the PaaS via travis (Reliability Engineering is a good place to start with any questions).
There are pre-commit hooks available to help when creating or editing markdown.
Using the script:
pip install pre-commit
vale linterInstall the
./vale-lint.sh command used by pre-commit will install the vale linter from Homebrew if it can't find it. For non-macOS systems you can install the binary:
Download the latest release.
wget https://github.com/ValeLint/vale/releases/download/0.9.0/vale_0.9.0_Linux_64-bit.tar.gz tar zxvf vale_0.9.0_Linux_64-bit.tar.gz chmod +x vale && mv vale /usr/local/bin/vale
The styles are copied from https://github.com/alphagov/govuk-developer-docs/tree/bc94d39dce23236fc61238464010713daf5213f9/styles