MkPandocs
MkPandocs 是一个静态站点生成器，专为项目文档设计。它是 MkDocs 的 Pandoc 渲染分支，基于 properdocs 修改，使用 Pandoc 替代 Python-Markdown 作为渲染引擎。
⚠️ 项目状态
本项目仍在积极开发中，功能和 API 随时可能发生变更。目前尚未完善，不建议用于生产环境。
快速开始
pip install mkpandocs
mkpandocs install-deps
mkpandocs new my-docs
cd my-docs
mkpandocs serve
文档
完整的技术文档、使用方法和配置说明请访问：
贡献指南
欢迎参与贡献！请遵循以下流程：
- Fork 本仓库
- 创建特性分支 (
git checkout -b feature/amazing-feature) - 提交更改 (
git commit -m 'Add amazing feature') - 推送到分支 (
git push origin feature/amazing-feature) - 创建 Pull Request
开发环境
git clone https://github.com/RainPPR/mkpandocs.git
cd mkpandocs
uv sync --group dev
uv run mkpandocs install-deps
代码规范
- 使用
ruff进行代码检查和格式化 - 使用
mypy进行类型检查 - 所有新功能必须包含测试
相关链接
致谢
MkPandocs 基于 MkDocs 项目开发，感谢 MkDocs 团队的出色工作。
许可证
MkPandocs 基于 BSD-2-Clause 许可证 发布。
1 maintainer
Metadata
1 maintainer
Release files for mkpandocs 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkpandocs-1.0.1.tar.gz | 275.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkpandocs-1.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 503.0 kB
Release files / mkpandocs-1.0.1.tar.gz
| Download URL | mkpandocs-1.0.1.tar.gz |
|---|---|
| Size | 275.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d50b59ad466d2fd6a59374b524e1806aecc5158e359a332a5f7ee8fcd2e5cfb2
|
|
BLAKE2b-256 checksum How to use checksums |
22e2fd7325a92a046b7bdddd952b19b833d6e9b3839abe54260eb55b51b19beb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 31, 2026.
Transparency logRelease files / mkpandocs-1.0.1-py3-none-any.whl
| Download URL | mkpandocs-1.0.1-py3-none-any.whl |
|---|---|
| Size | 227.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b039b10d087bf37b8f04d1a7d85129a17be44e145bb868c973dccac8f4ee75e6
|
|
BLAKE2b-256 checksum How to use checksums |
9fd3d99b763faa79cb4fa64dc336f8a487c35492472742a4dec42dc3c28d9cce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 31, 2026.
Transparency log
