👉 https://docs.publishing.service.gov.uk
This is a static site generated with Middleman.
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 do into /app.
You can pull down the latest version of the template by running:
bin/update
- Ruby
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
Build the site with:
bundle exec middleman build
This will create a bunch of static files in /build.
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.
Install pre-commit:
Homebrew:
brew install pre-commit
pre-commit install
Pip:
pip install pre-commit
Install vale linter:
Homebrew:
brew tap ValeLint/vale
brew install vale
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