rmoorman/tech-docs-template

A template for building technical documentation with a GOV.UK style

Tech Docs Template

The Tech Docs Template is a middleman template that you can use to build technical documentation using a GOV.UK style.

This repo is the template used to generate new sites. The generated site uses HTML, CSS, JS and images from the tech docs gem.

👉 See alphagov.github.io/tech-docs-manual

Local development

If you make changes to the template you can create a test site with this command. Make sure that you've committed your changes first, because Middleman works with Git.

bundle install
bundle exec middleman init tmp/test-run -T file://$(pwd)
cd tmp/test-run
bundle exec middleman server

Your generated site should appear on http://localhost:4567.