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.8.0.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file mkdocs_kpn-1.8.0.tar.gz.

File metadata

  • Download URL: mkdocs_kpn-1.8.0.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkdocs_kpn-1.8.0.tar.gz
Algorithm Hash digest
SHA256 f7595239cf2da4d8ae09e4f34e4432fdc93a99e17d5b2e8bea222c17c3f8c808
MD5 3730a97cc86aeb3b33266f51624f552c
BLAKE2b-256 d48568b7a1f286d21c338a71bdb22523a5b6a64337969d9f2e03c90122d27c13

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_kpn-1.8.0.tar.gz:

Publisher: pythonpublish.yaml on kpn/mkdocs-kpn-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: mkdocs_kpn-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkdocs_kpn-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0f482c177ed2829eada2b452276468d09b9076947805f8bbc0511a5b888346d
MD5 f6bbf52ca4262625eea7a9dcfe317b99
BLAKE2b-256 157747495d960de3a63dc6b207e41bc7434ccba6045e0656e1bcd209c55d220e

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_kpn-1.8.0-py3-none-any.whl:

Publisher: pythonpublish.yaml on kpn/mkdocs-kpn-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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