🚗 Getting Started
Setting up your documentation site to use this theme couldn't be easier. The quickest and easiest way to get up and running is to install with pip.
To be able to use this theme, you need to be using at least Python v3.8.
💻 Installation
with pip
ONS MkDocs Theme is published as a Python package and can be installed with
pip, ideally by using a virtual environment. Open up a terminal and install
ONS MkDocs Theme with:
pip install ons_mkdocs_theme
This will automatically install compatible versions of all dependencies: MkDocs, Markdown, Pygments and Python Markdown Extensions.
!!! tip
If you don't have prior experience with Python, we recommend reading
[Using Python's pip to Manage Your Projects' Dependencies], which is a
really good introduction on the mechanics of Python package management and
helps you troubleshoot if you run into errors.
with git
ONS MkDocs Theme can be directly used from GitHub by cloning the repository into a subfolder of your project root folder.
Simply create a folder called ons_mkdocs_theme. In the terminal, ensure you are in the root folder directory of your project and run the following command:
mkdir ons_mkdocs_theme
You then need to cd into the new directory with the following command:
cd ons_mkdocs_theme
To clone the theme files, run the following command:
git clone https://github.com/ONSdigital/ons_mkdocs_theme
Next, install the theme and its dependencies with:
pip install -e .
Metadata
Release files for ons-mkdocs-theme 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ons_mkdocs_theme-1.3.0.tar.gz | 4.1 MB | Without provenance | Details for ons_mkdocs_theme-1.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ons_mkdocs_theme-1.3.0-py3-none-any.whl | Python 3 | none | any | Details for ons_mkdocs_theme-1.3.0-py3-none-any.whl |
Total release size: 12.5 MB
Release files / ons_mkdocs_theme-1.3.0.tar.gz
| Download URL | ons_mkdocs_theme-1.3.0.tar.gz |
|---|---|
| Size | 4.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5169ad2b011649ed022277e2e347d44d715f1b3477e3cbfbe97659af8d83d2ab
|
|
BLAKE2b-256 checksum How to use checksums |
8243424d1cf60fe4c604c39695bb920404afbce4454186bfe4a46dbe74ae5240
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / ons_mkdocs_theme-1.3.0-py3-none-any.whl
| Download URL | ons_mkdocs_theme-1.3.0-py3-none-any.whl |
|---|---|
| Size | 8.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
db4256d2e0fa0e4a0691940993392414848257e719a43e9a0de53b1f0aae9132
|
|
BLAKE2b-256 checksum How to use checksums |
77a04ae7d6140c9e4f17908e587b0eee3d79a58e7d06256877aa26db88d722a2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Security for ons-mkdocs-theme 1.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.