This repository is used to generate the documentation website for the Tech Docs Template and uses the template itself.
The Tech Docs Template is a middleman template that you can use to build technical documentation websites using a GOV.UK style.
To use the Tech Docs Template you need:
To make changes to the documentation for the Tech Docs Template website, edit files in the source folder of this repository.
You can add content by editing the .html.md.erb files. These files support content in:
- Markdown
- HTML
- Ruby
👉 You can use Markdown and HTML to generate different content types and Ruby partials to manage content.
👉 Learn more about producing more complex page structures for your website.
To preview your new website locally, navigate to your project folder and run:
bundle exec middleman server👉 See the generated website on http://localhost:4567 in your browser. Any content changes you make to your website will be updated in real time.
To shut down the Middleman instance running on your machine, use ctrl+C.
If you make changes to the config/tech-docs.yml configuration file, you need to restart Middleman to see the changes.
Travis CI automatically publishes changes merged into the master branch of this repository.
Run bundle exec middleman build --verbose to get detailed error messages to help with finding the problem.
Please refer to the alphagov code of conduct.
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.