KPN Theme¶

Theme for your favorite documentation tool:

• MkDocs v1
• ProperDocs
• Zensical

Create a Beautiful KPN Project Documentation¶

KPN Theme is a theme for MkDocs v1, ProperDocs or Zensical. These are excellent static site generators geared towards project documentation. It is built using KPN Styles.

Quickstart¶

Install the latest version of KPN theme with pip (after your favorite doc library):

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