Tech Docs Template - gem
This repo is part of the GOV.UK Tech docs project. This repo contains the Ruby gem that is used to distribute most of code that is used to generate the site.
To generate a new site with the template, see the manual.
There are 2 ways to develop with this gem.
The first is to point your site's Gemfile to your local checkout, and use it normally. This is good for if you want to see what effect your changes have to the actual site.
gem 'govuk_tech_docs', path: '../tech-docs-gem'
The second is to use the example app in this repo. You can start it by
cd example bundle install bundle exec middleman serve
Your site will appear on http://localhost:4567.
To run the tests on your machine:
bundle exec rake jasmine
- Navigate to
http://localhost:8888in a browser of your choosing
- Peruse the output of your tests
Or, on the command line, run
bundle exec rake jasmine:ci.
Releasing new versions
At the moment this gem has to be released manually. There's a story on the Reliability Engineering backlog to automate this.
To release a new version, create a new Pull Request that updates version.rb and CHANGELOG.md. Don't mix this in with other changes - this makes it easier to find out what was released when. See this PR to release a new version as an example.
Owners of the Rubygem can then run
rake release to release a new version.
The gem is available as open source under the terms of the MIT License.