mkdocs-kpn

Name	mkdocs-kpn JSON
Version	1.7.3 JSON
	download
home_page	https://github.com/kpn/mkdocs-kpn-theme
Summary	A KPN-styles theme for MkDocs
upload_time	2024-01-31 08:38:31
maintainer
docs_url	None
author	Santiago Fraire Willemoës
requires_python
license	MIT
keywords	mkdocs documentation theme
VCS
bugtrack_url
requirements	mkdocs markdown pymdown-extensions plantuml-markdown
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kpn/mkdocs-kpn-theme",
    "name": "mkdocs-kpn",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "mkdocs,documentation,theme",
    "author": "Santiago Fraire Willemo\u00ebs",
    "author_email": "de-ddci@kpn.com",
    "download_url": "https://files.pythonhosted.org/packages/c0/3a/9539017c0f6c02f9a927d5434075395c869812f47fe3d580da613dcc870e/mkdocs-kpn-1.7.3.tar.gz",
    "platform": null,
    "description": "# KPN for MkDocs\n\n[![Conventional\nCommits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)\n[![PyPI Package latest\nrelease](https://img.shields.io/pypi/v/mkdocs-kpn.svg?style=flat-square)](https://pypi.org/project/mkdocs-kpn/)\n\n![theme light image](docs/images/example-light.png)\n\n![theme dark image](docs/images/example-dark.png)\n\n## Create a beautiful KPN project documentation\n\nKPN Theme is a theme for MkDocs, an excellent static site generator geared towards project documentation.\nIt is built using [KPN Styles][kpn_styles].\n\n## Quickstart\n\nInstall the latest version of KPN theme with pip:\n\n```bash\npip install mkdocs-kpn\n```\n\nAppend the following line to your project's mkdocs.yml:\n\n```yaml\ntheme:\n  name: 'kpn'\n```\n\n## What to expect\n\n- Responsive design and fluid layout for all kinds of screens and devices,\ndesigned to serve your project documentation in a user-friendly way.\n- Support for a lot of markdown extensions.\n\n## Change repo icon\n\n```yaml\n# options: github | gitlab | bitbucket | gitea\nextra:\n  repo_icon: 'github'\n```\n\n## Add version to site\n\nEdit `mkdocs.yml` with\n\n```yaml\nextra:\n  version:\n    provider: 'manual'\n    version: 1.2.2\n```\n\n[kpn_styles]: https://style.kpn.com/\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A KPN-styles theme for MkDocs",
    "version": "1.7.3",
    "project_urls": {
        "Homepage": "https://github.com/kpn/mkdocs-kpn-theme"
    },
    "split_keywords": [
        "mkdocs",
        "documentation",
        "theme"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ab6ddbe124311b403b480a8a16b3c44a63954e751af450cdc88547ce58d9e074",
                "md5": "d4a603af805b8c348dad6330ace60f67",
                "sha256": "fb8a2e4e2fa77817ef7a92d82a569616fac0dd1ecb1138d78032c5581b0ccfa5"
            },
            "downloads": -1,
            "filename": "mkdocs_kpn-1.7.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d4a603af805b8c348dad6330ace60f67",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 2289718,
            "upload_time": "2024-01-31T08:38:29",
            "upload_time_iso_8601": "2024-01-31T08:38:29.230365Z",
            "url": "https://files.pythonhosted.org/packages/ab/6d/dbe124311b403b480a8a16b3c44a63954e751af450cdc88547ce58d9e074/mkdocs_kpn-1.7.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c03a9539017c0f6c02f9a927d5434075395c869812f47fe3d580da613dcc870e",
                "md5": "5fdf87bd498d5e5b0df42eb0b22e4526",
                "sha256": "2340ca4c5d637e97d8c6b621867956a23439e2aa14fcebd04b32295280137e7a"
            },
            "downloads": -1,
            "filename": "mkdocs-kpn-1.7.3.tar.gz",
            "has_sig": false,
            "md5_digest": "5fdf87bd498d5e5b0df42eb0b22e4526",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2292164,
            "upload_time": "2024-01-31T08:38:31",
            "upload_time_iso_8601": "2024-01-31T08:38:31.704990Z",
            "url": "https://files.pythonhosted.org/packages/c0/3a/9539017c0f6c02f9a927d5434075395c869812f47fe3d580da613dcc870e/mkdocs-kpn-1.7.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-31 08:38:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kpn",
    "github_project": "mkdocs-kpn-theme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "mkdocs",
            "specs": [
                [
                    ">=",
                    "1.0"
                ]
            ]
        },
        {
            "name": "markdown",
            "specs": [
                [
                    ">=",
                    "3.3.7"
                ]
            ]
        },
        {
            "name": "pymdown-extensions",
            "specs": [
                [
                    ">=",
                    "9.4"
                ]
            ]
        },
        {
            "name": "plantuml-markdown",
            "specs": [
                [
                    ">=",
                    "3.4.2"
                ],
                [
                    "<",
                    "4"
                ]
            ]
        }
    ],
    "lcname": "mkdocs-kpn"
}