Skip to content

alphagov/govuk-developer-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6fc2b8e Β· Jan 23, 2025
Jan 22, 2025
Jan 22, 2025
Jul 30, 2020
Dec 11, 2024
Jan 23, 2025
May 9, 2024
Mar 23, 2021
Jan 20, 2025
Jan 22, 2025
Mar 15, 2021
Mar 22, 2024
May 1, 2024
Mar 23, 2021
Dec 14, 2016
Nov 9, 2021
Apr 30, 2024
Mar 7, 2018
May 2, 2024
Jan 21, 2025
Dec 2, 2022
Mar 5, 2024
Jan 30, 2024
Dec 21, 2016
May 2, 2023
May 9, 2024
Jan 31, 2024
Feb 13, 2019

Repository files navigation

GOV.UK Developer Docs

πŸ‘‰ https://docs.publishing.service.gov.uk/

This is a static site generated with Middleman, using alphagov/tech-docs-template.

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.

Build the app locally

bundle install

Run the tests locally

bundle exec rake

Run the app locally

SKIP_PROXY_PAGES=true ./startup.sh

Proxy pages

The live docs site includes pages from other alphagov GitHub repositories. To test this locally, omit SKIP_PROXY_PAGES=true from the command above.

The app downloads these "proxy pages" at startup and this can cause GitHub to rate limit your requests. You can pass a valid GitHub API token to the app to help avoid this:

  1. Create a GitHub token. The token doesn't need any scopes.

  2. Store the token in a .env file:

    GITHUB_TOKEN=somethingsomething
  3. Start the application:

    ./startup.sh

Update to the latest Tech Docs template

bin/update

Deployment

We host GOV.UK Developer Docs as a static site on GitHub Pages. The ci.yml GitHub Actions workflow updates the site automatically:

  • when a PR is merged to the default branch
  • on an hourly schedule, to pick up changes to docs included from other repos

Build the static site locally

NO_CONTRACTS=true bundle exec middleman build

This will create a build directory containing a set of HTML files.

Licence

MIT License