https://github.com/kpn/mkdocs-kpn-theme

KPN theme for MkDocs | owner=flow
https://github.com/kpn/mkdocs-kpn-theme

html mkdocs-theme python

Last synced: 6 months ago
JSON representation

KPN theme for MkDocs | owner=flow

• Host: GitHub
• URL: https://github.com/kpn/mkdocs-kpn-theme
• Owner: kpn
• License: mit
• Created: 2020-04-02T12:00:18.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-31T08:38:35.000Z (about 2 years ago)
• Last Synced: 2025-09-06T14:48:25.531Z (6 months ago)
• Topics: html, mkdocs-theme, python
• Language: HTML
• Homepage: https://kpn.github.io/mkdocs-kpn-theme/
• Size: 2.99 MB
• Stars: 9
• Watchers: 9
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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/