mkpy

Minimalistic Python library for generating and serving documentation from Markdown files.

Installation

pip install mkpy-client

Quick Start

from mkpy import Docs

docs = Docs(
    title="My Project",
    theme="dark",
    port=3000,
)
docs.run()

CLI

# Run with defaults
mkpy serve

# With options
mkpy serve --folder docs --theme dark --port 3000

# From config file
mkpy serve main.py

Features

Automatic markdown to HTML conversion
Built-in HTTP server
Auto routes from file structure
Light and dark themes
Custom CSS and JavaScript
Auto-discovery of css/ and js/ folders
Navigation menu
Sitemap generation

Configuration File

# main.py
from mkpy import Docs

docs = Docs(
    folder="docs",
    title="My Project",
    theme="dark",
    port=3000,
    custom_css="styles.css",
)

Structure

docs/
├── index.md
├── about.md
└── guide/
    └── install.md

Routes:

/ -> index.md
/about -> about.md
/guide/install -> guide/install.md

Requirements

Python 3.9+
markdown
rich (optional, for colored output)
typer (optional, for CLI)

License

MIT

Download files

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

Source Distribution

mkpy_client-1.4.5.tar.gz (15.3 kB view details)

Uploaded Mar 15, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

mkpy_client-1.4.5-py3-none-any.whl (16.6 kB view details)

Uploaded Mar 15, 2026 Python 3

File details

Details for the file mkpy_client-1.4.5.tar.gz.

File metadata

Download URL: mkpy_client-1.4.5.tar.gz
Upload date: Mar 15, 2026
Size: 15.3 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkpy_client-1.4.5.tar.gz
Algorithm	Hash digest
SHA256	`4860a1fd8f33108f635860f770cc943ac2857bc3a73e0f37138656e8c675634a`
MD5	`9de34ee84968d1cc25d3bdf5dc840a14`
BLAKE2b-256	`f49cad5c1a8efa7ce15a466d8f0926d3579e623adc585b3d1db8bdd560c84b9c`

See more details on using hashes here.

File details

Details for the file mkpy_client-1.4.5-py3-none-any.whl.

File metadata

Download URL: mkpy_client-1.4.5-py3-none-any.whl
Upload date: Mar 15, 2026
Size: 16.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkpy_client-1.4.5-py3-none-any.whl
Algorithm	Hash digest
SHA256	`3e1ed7d325967e2ee9f93d45e56099a95fd2ac8092c66a6679d5632307906633`
MD5	`893e1aacb115b15a7aea856cb7b10e5e`
BLAKE2b-256	`bedcab2acc5eef46e2de611826d419dacf920ed1f0336fd5b2a34da6235e969d`