Tech Docs Template - gem
To find out more about setting up and managing content for a website using this template, see the Tech Docs Template documentation.
Everybody who uses this project is encouraged to contribute.
You can find out more about contributing to this project from theCONTRIBUTING.md file.
npm to download the govuk-frontend package. To update to a new version, change the version in the package.json file and run
There are 2 ways to develop with this gem. You can see your changes on either:
- your own Tech Docs Template website
- the example in this repository
Use your own Tech Docs Template website
To see how your changes to the gem affect your website, point your website's Gemfile to your local checkout:
gem 'govuk_tech_docs', path: '../tech-docs-gem'
To preview your documentation changes locally, see the Tech Docs Template documentation on previewing your documentation.
Use the example in this repo
To start the example in this repo, run:
cd example bundle install bundle exec middleman server
See your website on
http://localhost:4567 in your browser.
For more information on previewing your documentation locally, see the Tech Docs template documentation on previewing your documentation.
You can run these tests and see the results in your browser.
bundle exec rake jasmine.
- Go to
http://localhost:8888in your browser.
To run the tests and see the results in your terminal, run:
bundle exec rake jasmine:ci
Releasing new versions
Do not include other changes in your pull request, as this makes it easier to find out what was released when. See an example of a PR for releasing a new version.
Travis will automatically release a new version to Rubygems.org.
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.