Metadata-Version: 2.1
Name: ons_mkdocs_theme
Version: 1.0.1
Summary: An ONS theme for MkDocs based on Material for MkDocs for creating documentation websites
Home-page: https://github.com/ONSdigital/ons_mkdocs_theme
Author: Keilan Evans, ONS
Author-email: Keilan.Evans@ons.gov.uk
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: <3.12,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Babel==2.15.0
Requires-Dist: certifi==2024.7.4
Requires-Dist: charset-normalizer==3.3.2
Requires-Dist: click==8.1.7
Requires-Dist: colorama==0.4.6
Requires-Dist: csscompressor==0.9.5
Requires-Dist: ghp-import==2.1.0
Requires-Dist: htmlmin2==0.1.13
Requires-Dist: idna==3.7
Requires-Dist: Jinja2==3.1.4
Requires-Dist: jsmin==3.0.1
Requires-Dist: Markdown==3.6
Requires-Dist: MarkupSafe==2.1.5
Requires-Dist: mergedeep==1.3.4
Requires-Dist: mkdocs==1.6.0
Requires-Dist: mkdocs-get-deps==0.2.0
Requires-Dist: mkdocs-material==9.5.30
Requires-Dist: mkdocs-material-extensions==1.3.1
Requires-Dist: mkdocs-minify-plugin==0.8.0
Requires-Dist: packaging==24.1
Requires-Dist: paginate==0.5.6
Requires-Dist: pathspec==0.12.1
Requires-Dist: platformdirs==4.2.2
Requires-Dist: Pygments==2.18.0
Requires-Dist: pymdown-extensions==10.9
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: PyYAML==6.0.1
Requires-Dist: pyyaml_env_tag==0.1
Requires-Dist: regex==2024.7.24
Requires-Dist: requests==2.32.3
Requires-Dist: six==1.16.0
Requires-Dist: urllib3==2.2.2
Requires-Dist: watchdog==4.0.1

<p align="center" style="padding: 50px">
    <img src="ons_mkdocs_theme/assets/images/logo.svg" width="320px">
</p>

## :rocket: MkDocs ONS Theme

This is an Office for National Statistics (ONS) branded theme that can be used in conjunction with MkDocs.

The purpose of this theme is to give users a way of generating documentation that is styled for ONS.

This theme leans heavily on the Material for MkDocs that was created by Martin Donath. The original files can be accessed from [GitHub].

## :file_folder: Documentation

You can access the [documentation] for this package and see the theme live.

## :race_car: Getting Started

ONS Theme for MkDocs is a powerful documentation framework on top of [MkDocs], a static site generator for project documentation. If you're familiar with Python, you can install ONS Theme for MkDocs with `pip`, the Python package manager.

## :computer: Installation

#### With PIP

ONS Theme for MkDocs is published as a Python package and can be installed with `pip`, ideally by using a [virtual environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html). Open up a terminal and install ONS Theme for MkDocs with:

```py
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](https://facelessuser.github.io/pymdown-extensions/), 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 Theme for MkDocs can be directly used from GitHub by cloning the repository into a subfolder of your project root.

```sh
git clone https://github.com/ONSdigital/ons_mkdocs_theme
```

Next, install the theme and its dependencies with:

```sh
pip install -e ons-theme-for-mkdocs
```

[MkDocs]: https://www.mkdocs.org
[GitHub]: https://github.com/squidfunk/mkdocs-material
[Markdown]: https://www.markdownguide.org/getting-started/#:~:text=Markdown%20is%20a%20lightweight%20markup,than%20using%20a%20WYSIWYG%20editor.
[Pygments]: https://pygments.org/
[documentation]: https://didactic-dollop-wgj8yzk.pages.github.io/
