---
title: MkDocs Tech Docs Template
hide:
- navigation
- toc
---
<style>
.md-typeset h1 {
display: none;
}
.md-main__inner {
margin-top: 0px;
}
.md-content__button {
display: none;
}
</style>
!!! banner "Build flexible documentation"
![Services][homepage_illustration]{ align=right width=300px height=300px}
The **MkDocs Tech Docs Template** is a Python-based alternative to the Ruby-based [Tech Docs Template][TDT] with the following benefits:
- easy to [set up][setup], [customise][customise] and [enhance][contribute]
- adapts the [MkDocs Materials theme][material] to follow the [GOV.UK style][gov-uk]
- compatible with the vast ecosystem of [MkDocs plugins][plugins]
- unified tech stack for Python-based projects
[Get Started ＞][setup]{ .md-button .md-button--primary}
!!! warning inline end "Prototype"
This template is under construction. As it has not yet passed an accessibility audit, we currently do not recommend using it.
!!! quote "Restrictions"
You can use the MkDocs Tech Docs Template even if your documentation site is not part of GOV.UK, but it must not:
- identify itself as part of GOV.UK
- use the crown or GOV.UK logotype in the header
- use the GDS Transport typeface
- say or suggest that it is an official UK government website
<br>
[gov.ukStyle]: https://design-system.service.gov.uk/
[homepage_illustration]: homepage-illustration.svg
[TDT]: https://tdt-documentation.london.cloudapps.digital/
[setup]: ./setup/
[customise]: ./setup/customise.md
[contribute]: ./setup/CONTRIBUTE.md
[material]: https://squidfunk.github.io/mkdocs-material/
[plugins]: plugins/
[gov-uk]: https://design-system.service.gov.uk/
Raw data
{
"_id": null,
"home_page": "https://github.com/ministryofjustice/mkdocs-tech-docs-template",
"name": "mkdocs-tech-docs-template",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "mkdocs,technical,documentation",
"author": "Soumaya Mauthoor",
"author_email": "soumaya.mauthoor@justice.gov.uk",
"download_url": "https://files.pythonhosted.org/packages/80/19/f896faff99d6fde251f5806880ca28239aa7a7356b29b0cb10133eb99f61/mkdocs-tech-docs-template-0.1.2.tar.gz",
"platform": null,
"description": "---\ntitle: MkDocs Tech Docs Template\nhide:\n- navigation\n- toc\n---\n\n<style>\n .md-typeset h1 {\n display: none;\n }\n \n .md-main__inner {\n margin-top: 0px;\n }\n\n .md-content__button {\n display: none;\n }\n</style>\n\n!!! banner \"Build flexible documentation\"\n\n ![Services][homepage_illustration]{ align=right width=300px height=300px}\n\n The **MkDocs Tech Docs Template** is a Python-based alternative to the Ruby-based [Tech Docs Template][TDT] with the following benefits:\n\n - easy to [set up][setup], [customise][customise] and [enhance][contribute]\n - adapts the [MkDocs Materials theme][material] to follow the [GOV.UK style][gov-uk]\n - compatible with the vast ecosystem of [MkDocs plugins][plugins]\n - unified tech stack for Python-based projects\n\n [Get Started \uff1e][setup]{ .md-button .md-button--primary}\n\n!!! warning inline end \"Prototype\"\n\n This template is under construction. As it has not yet passed an accessibility audit, we currently do not recommend using it.\n\n!!! quote \"Restrictions\"\n\n You can use the MkDocs Tech Docs Template even if your documentation site is not part of GOV.UK, but it must not:\n\n - identify itself as part of GOV.UK\n - use the crown or GOV.UK logotype in the header\n - use the GDS Transport typeface\n - say or suggest that it is an official UK government website\n\n<br>\n\n[gov.ukStyle]: https://design-system.service.gov.uk/\n[homepage_illustration]: homepage-illustration.svg\n[TDT]: https://tdt-documentation.london.cloudapps.digital/\n[setup]: ./setup/\n[customise]: ./setup/customise.md\n[contribute]: ./setup/CONTRIBUTE.md\n[material]: https://squidfunk.github.io/mkdocs-material/\n[plugins]: plugins/\n[gov-uk]: https://design-system.service.gov.uk/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDocs theme that you can use to build technical documentation with a GOV.UK",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/ministryofjustice/mkdocs-tech-docs-template"
},
"split_keywords": [
"mkdocs",
"technical",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89febdb8562c8cad08fc974cffd882e9be6934106800535f9ac1a69e25003ee4",
"md5": "ba6bf8d4e5e44ae79120c897033f2f59",
"sha256": "e8c61d02086d4fa8b87ba73c6545ca8b3d14fdeacfebc7ba06fdb8b1ea99464e"
},
"downloads": -1,
"filename": "mkdocs_tech_docs_template-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba6bf8d4e5e44ae79120c897033f2f59",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 40372,
"upload_time": "2023-08-05T14:05:11",
"upload_time_iso_8601": "2023-08-05T14:05:11.046421Z",
"url": "https://files.pythonhosted.org/packages/89/fe/bdb8562c8cad08fc974cffd882e9be6934106800535f9ac1a69e25003ee4/mkdocs_tech_docs_template-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8019f896faff99d6fde251f5806880ca28239aa7a7356b29b0cb10133eb99f61",
"md5": "cd06f263dbc6f10db9ec37b9641635c9",
"sha256": "d1357bb044fa114e5fedaa52a1f4602471bf9931bf2998a4250d6d4b95b4b75e"
},
"downloads": -1,
"filename": "mkdocs-tech-docs-template-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "cd06f263dbc6f10db9ec37b9641635c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 40149,
"upload_time": "2023-08-05T14:05:12",
"upload_time_iso_8601": "2023-08-05T14:05:12.691093Z",
"url": "https://files.pythonhosted.org/packages/80/19/f896faff99d6fde251f5806880ca28239aa7a7356b29b0cb10133eb99f61/mkdocs-tech-docs-template-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-05 14:05:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ministryofjustice",
"github_project": "mkdocs-tech-docs-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-tech-docs-template"
}
JSON
