README.md

Explore education statistics API documentation

This repository is used to generate the documentation website for the Explore education statistics API. It is based on the GOV.UK Technical Documentation Template for building

Getting started

The following pre-requisite dependencies are required to get started:

• Node.js v18+ (versions can be managed with nvm)
• Ruby v2.7.6 (versions can be managed with rbenv or rvm)

Once these have been installed, follow these steps:

1. Install the project's Ruby dependencies:

   bundle install

2. Start the development server:

   bundle exec middleman

   This will start the Middleman development server on https://localhost:4567.

3. Optional. To automatically refresh the browser upon code changes, install the LiveReload browser extension.

For further guidance on how to develop this documentation, please visit the Technical Documentation Template website.

Publishing changes

GitHub Actions automatically publishes changes merged into the main branch of this repository.

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.

The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.