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
1 maintainer
Metadata
1 maintainer
Release files for mkpy-client 1.4.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkpy_client-1.4.5.tar.gz | 15.3 kB | Without provenance | Details for mkpy_client-1.4.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkpy_client-1.4.5-py3-none-any.whl | Python 3 | none | any | Details for mkpy_client-1.4.5-py3-none-any.whl |
Total release size: 31.9 kB
Release files / mkpy_client-1.4.5.tar.gz
| Download URL | mkpy_client-1.4.5.tar.gz |
|---|---|
| Size | 15.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4860a1fd8f33108f635860f770cc943ac2857bc3a73e0f37138656e8c675634a
|
|
BLAKE2b-256 checksum How to use checksums |
f49cad5c1a8efa7ce15a466d8f0926d3579e623adc585b3d1db8bdd560c84b9c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / mkpy_client-1.4.5-py3-none-any.whl
| Download URL | mkpy_client-1.4.5-py3-none-any.whl |
|---|---|
| Size | 16.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3e1ed7d325967e2ee9f93d45e56099a95fd2ac8092c66a6679d5632307906633
|
|
BLAKE2b-256 checksum How to use checksums |
bedcab2acc5eef46e2de611826d419dacf920ed1f0336fd5b2a34da6235e969d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Security for mkpy-client 1.4.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
