MkDocs theme that you can use to build technical documentation with a GOV.UK
Project description
MkDocs Tech Docs Template
!!! danger ""
This template is under construction and should only be used for prototyping
The MkDocs Tech Docs Template is an MkDocs theme that you can use to build technical documentation with a GOV.UK style. For a demo visit mkdocs-tech-docs-template.
The MkDocs Tech Docs Template is a python-based alternative to the ruby-based Middleman Tech Docs Template with the following benefits:
- simple to setup, use and customise
- exploits the MkDocs Materials theme and all it's associated features
- compatible with the vast and growing ecosystem of MkDocs Plugins see plugins for some examples
- unified tech stack for python-based teams and projects
- easy to upgrade as new versions of the theme are released
You’re welcome to use the MkDocs Tech Docs 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
Usage
Please refer to Usage for more details.
Questions
Please raise on Discussions.
Contribute
👉 Find out how to contribute.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-tech-docs-template-0.0.16.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2530611e5c0fe8aee29fa41734f31bf8c48b57e2498cf63a3a6d95909e58e7d |
|
MD5 | 365b5ad27d0ee3512f72fa7b9153981a |
|
BLAKE2b-256 | 7ebb89775b55953f3047243d29ba54ce15e149555346bd5f4760965a4a0c3e88 |
Hashes for mkdocs_tech_docs_template-0.0.16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01179cc8d2be9d41678def45db4f9bca61c073988fb5f4d35700c213403dc211 |
|
MD5 | 087ade7342b9812b8f73aa1738cda212 |
|
BLAKE2b-256 | 323dddc192354c2b29efd2327ea33000ebcbbcdfe515395191183b9a907af7cf |