DSS Tech Docs Template - gem

This repo contains the Ruby gem that distributes the Tech Docs Template. The Tech Docs Template is a middleman template that you can use to build technical documentation using a DSS style. This repository will age quickly as there is no attempt to keep this in sync with the published GEM. This repository was created on 25th April 2019.

👉 Find out more about the template and its features from the Tech Docs Template documentation.

👉 Find out how to generate a new website with the Tech Docs Template.

Everybody who uses this project is encouraged to contribute.

👉 See CONTRIBUTING.md for guidance on making changes.

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

If you want to see how your changes to the gem affect your website, you have to point your site's Gemfile to your local checkout:

gem 'dss_tech_docs', path: '../tech-docs-gem'

To view your changes locally run:

bundle exec middleman server

See your website on http://localhost:4567 in your browser.

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.

The repository contains automated JavaScript tests that use Jasmine test framework.

To run the tests and see the results in your browser:

1. Run bundle exec rake jasmine
2. Go to http://localhost:8888 in your browser

To run the tests and see the results in your terminal, run:

bundle exec rake jasmine:ci

This is a manual process for now.

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.