https://github.com/alphagov/tech-docs-template
A template for building technical documentation with a GOV.UK style
https://github.com/alphagov/tech-docs-template
cross-gds tech-docs-template tech-writers
Last synced: about 1 month ago
JSON representation
A template for building technical documentation with a GOV.UK style
- Host: GitHub
- URL: https://github.com/alphagov/tech-docs-template
- Owner: alphagov
- License: mit
- Created: 2016-10-28T10:16:46.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T19:27:39.000Z (about 1 year ago)
- Last Synced: 2025-05-08T22:53:03.645Z (about 1 month ago)
- Topics: cross-gds, tech-docs-template, tech-writers
- Language: HTML
- Homepage: https://tdt-documentation.london.cloudapps.digital
- Size: 986 KB
- Stars: 78
- Watchers: 77
- Forks: 36
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tech Docs Template
The Tech Docs Template is a [Middleman template][mmt] 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](https://github.com/alphagov/tech-docs-gem).
You’re welcome to use the template even if your service isn’t considered part of GOV.UK, but your site or service must not:
- identify itself as being part of GOV.UK
- use the crown or GOV.UK logotype in the header
- use the GDS Transport typeface
- suggest that it’s an official UK government website if it’s not
👉 To find out more about setting up and managing content for a website using this template, see the [Tech Docs Template documentation][tdt-docs].
## Contribute
👉 Find out how to [contribute][contribute].
## Licence
Unless stated otherwise, the codebase is released under [the MIT License][mit].
This covers both the codebase and any sample code in the documentation.
The documentation is [© Crown copyright][copyright] and available under the terms of the [Open Government 3.0][ogl] licence.
[mit]: LICENCE
[copyright]: http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/
[ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
[mmt]: https://middlemanapp.com/advanced/project_templates/
[tdt-docs]: https://tdt-documentation.london.cloudapps.digital
[config]: https://tdt-documentation.london.cloudapps.digital/amend_project/configuration/#configuration-options
[frontmatter]: https://tdt-documentation.london.cloudapps.digital/frontmatter.html#frontmatter
[multipage]: https://tdt-documentation.london.cloudapps.digital/create_project/multipage/#build-a-multipage-documentation-site
[example-content]: https://tdt-documentation.london.cloudapps.digital/amend_project/content/#change-your-content
[partials]: https://tdt-documentation.london.cloudapps.digital/create_project/single_page/#add-partial-lines
[contribute]: https://tdt-documentation.london.cloudapps.digital/support/#contribute
[install-ruby]: https://tdt-documentation.london.cloudapps.digital/create_project/setup_local/#install-ruby
[install-middleman]: https://tdt-documentation.london.cloudapps.digital/create_project/setup_local/#install-ruby