simonwhatley / design-in-dfe

Guidance, standards and information on how to design consistent, accessible, understandable, and usable services for the Department for Education.

Design in DfE

👉 You can find out more about setting up and managing content for this service on the Tech Docs Template documentation site.

Before you start

To run this service on your machine, you need:

• Ruby (2.7.2 version)
• Middleman

Making changes

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.

Preview your changes locally

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.

Build

To build the HTML pages from content in your source folder, run:

bundle exec middleman build

Every time you run this command, the build folder gets generated from scratch. This means any changes to the build folder that are not part of the build command will get overwritten.

Troubleshooting

Run bundle update to make sure you're using the most recent Ruby gem versions.

Run bundle exec middleman build --verbose to get detailed error messages to help with finding the problem.

Licence

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.

This project is tested with BrowserStack.