This is the repository for the UK government's guidance and standards for developing digital services and contains both the assets and the content for the site.

The site is built using Jekyll, and the CSS is Sassified.

Instructions are here:

https://github.com/alphagov/wiki/wiki/HOWTO:-Deploy-the-Government-Service-Design-Manual

Depending on your version of Git, you may need to run these commands to bring in the GOV.UK Frontend Toolkit:

$ git submodule init
$ git submodule update

This should import Sass files from the GOV.UK Frontend Toolkit repository into /service-manual/assets/toolkit/.

Next, install dependencies using bundler::

$ bundle install

You need to create the content::

$ bundle exec jekyll build

To start the app::

$ bundle exec ruby app.rb

This will compile the site and make it available at http://localhost:4567/.

In a separate terminal, you'll need to run:

$ bundle exec jekyll build --watch

This will monitor the service manual and rebuild it whenever it's changed.

This application should run fine on Heroku. You will need to have set yourself up with a Heroku account and the command-line tools. Then create an application on Heroku.

> heroku create <app-name>

Make your change locally, commit and deploy them to Heroku as needed. If the code you're deploying is not in master, then you'll need to make sure you specify your local branch to push to master. Otherwise it will just deploy your local master (and probably not work as expected).

> git push heroku master

Then open https://app-name.herokuapp.com/service-manual/ to see your changes.

Pages in a Jekyll site begin with a section of YAML meta data, which specifies how the page should be rendered, where it should be linked from and so on.

The following keys are used throughout:

Index pages list out links to content pages, for example, the role specific pages that are built using the audience keys.