Skip to main content

A KPN-styles theme for MkDocs

Project description

KPN for MkDocs

Conventional Commits PyPI Package latest release

theme light image

theme dark image

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.

Quickstart

Install the latest version of KPN theme with pip:

pip install mkdocs-kpn

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

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

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

Add version to site

Edit mkdocs.yml with

extra:
  version:
    provider: 'manual'
    version: 1.2.2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-kpn-1.7.3.tar.gz (2.3 MB view hashes)

Uploaded Source

Built Distribution

mkdocs_kpn-1.7.3-py3-none-any.whl (2.3 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page