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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file mkdocs-kpn-1.7.3.tar.gz.

File metadata

  • Download URL: mkdocs-kpn-1.7.3.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for mkdocs-kpn-1.7.3.tar.gz
Algorithm Hash digest
SHA256 2340ca4c5d637e97d8c6b621867956a23439e2aa14fcebd04b32295280137e7a
MD5 5fdf87bd498d5e5b0df42eb0b22e4526
BLAKE2b-256 c03a9539017c0f6c02f9a927d5434075395c869812f47fe3d580da613dcc870e

See more details on using hashes here.

File details

Details for the file mkdocs_kpn-1.7.3-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_kpn-1.7.3-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for mkdocs_kpn-1.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fb8a2e4e2fa77817ef7a92d82a569616fac0dd1ecb1138d78032c5581b0ccfa5
MD5 d4a603af805b8c348dad6330ace60f67
BLAKE2b-256 ab6ddbe124311b403b480a8a16b3c44a63954e751af450cdc88547ce58d9e074

See more details on using hashes here.

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