Metadata-Version: 2.4
Name: mkdocs-kpn
Version: 1.8.1
Summary: A KPN-styles theme for MkDocs
Project-URL: Homepage, https://github.com/kpn/mkdocs-kpn-theme
Author-email: Santiago Fraire Willemoës <de-streams@kpn.com>
License-Expression: MIT
License-File: LICENSE
Keywords: documentation,mkdocs,theme
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=3.9
Requires-Dist: markdown>=3.3.7
Requires-Dist: mkdocs<2,>=1.0
Requires-Dist: plantuml-markdown<4,>=3.4.2
Requires-Dist: pymdown-extensions>=9.4
Description-Content-Type: text/markdown

# KPN for MkDocs

[![Conventional
Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)
[![PyPI Package latest
release](https://img.shields.io/pypi/v/mkdocs-kpn.svg?style=flat-square)](https://pypi.org/project/mkdocs-kpn/)

![theme light image](docs/images/example-light.png)

![theme dark image](docs/images/example-dark.png)

## Create a beautiful KPN project documentation

KPN Theme is a theme for MkDocs, an excellent static site generator geared towards project documentation.
It is built using [KPN Styles][kpn_styles].

## Quickstart

Install the latest version of KPN theme with pip:

```bash
pip install mkdocs-kpn
```

Append the following line to your project's mkdocs.yml:

```yaml
theme:
  name: 'kpn'
```

## What to expect

- Responsive design and fluid layout for all kinds of screens and devices,
designed to serve your project documentation in a user-friendly way.
- Support for a lot of markdown extensions.

## Change repo icon

```yaml
# options: github | gitlab | bitbucket | gitea
extra:
  repo_icon: 'github'
```

## Add version to site

Edit `mkdocs.yml` with

```yaml
extra:
  version:
    provider: 'manual'
    version: 1.2.2
```

[kpn_styles]: https://style.kpn.com/
