π 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.
bundle installbundle exec rake
SKIP_PROXY_PAGES=true ./startup.shThe 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:
-
Create a GitHub token. The token doesn't need any scopes.
-
Store the token in a
.envfile:GITHUB_TOKEN=somethingsomething
-
Start the application:
./startup.sh
bin/updateWe 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
NO_CONTRACTS=true bundle exec middleman buildThis will create a build directory containing a set of HTML files.