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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkpandocs-1.0.1.tar.gz.
File metadata
- Download URL: mkpandocs-1.0.1.tar.gz
- Upload date:
- Size: 275.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d50b59ad466d2fd6a59374b524e1806aecc5158e359a332a5f7ee8fcd2e5cfb2
|
|
| MD5 |
41f6bd6cbef0c86afb3b4866236f8c4f
|
|
| BLAKE2b-256 |
22e2fd7325a92a046b7bdddd952b19b833d6e9b3839abe54260eb55b51b19beb
|
Provenance
The following attestation bundles were made for mkpandocs-1.0.1.tar.gz:
Publisher:
deploy-release.yml on RainPPR/mkpandocs
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkpandocs-1.0.1.tar.gz -
Subject digest:
d50b59ad466d2fd6a59374b524e1806aecc5158e359a332a5f7ee8fcd2e5cfb2 - Sigstore transparency entry: 1202388502
- Sigstore integration time:
-
Permalink:
RainPPR/mkpandocs@606f8732d9c24c2631d8df2addadfd50c9fa0fd3 -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/RainPPR
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy-release.yml@606f8732d9c24c2631d8df2addadfd50c9fa0fd3 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mkpandocs-1.0.1-py3-none-any.whl.
File metadata
- Download URL: mkpandocs-1.0.1-py3-none-any.whl
- Upload date:
- Size: 227.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b039b10d087bf37b8f04d1a7d85129a17be44e145bb868c973dccac8f4ee75e6
|
|
| MD5 |
62dc4e3b2d19f7a47d871d4549953d7e
|
|
| BLAKE2b-256 |
9fd3d99b763faa79cb4fa64dc336f8a487c35492472742a4dec42dc3c28d9cce
|
Provenance
The following attestation bundles were made for mkpandocs-1.0.1-py3-none-any.whl:
Publisher:
deploy-release.yml on RainPPR/mkpandocs
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkpandocs-1.0.1-py3-none-any.whl -
Subject digest:
b039b10d087bf37b8f04d1a7d85129a17be44e145bb868c973dccac8f4ee75e6 - Sigstore transparency entry: 1202388514
- Sigstore integration time:
-
Permalink:
RainPPR/mkpandocs@606f8732d9c24c2631d8df2addadfd50c9fa0fd3 -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/RainPPR
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy-release.yml@606f8732d9c24c2631d8df2addadfd50c9fa0fd3 -
Trigger Event:
push
-
Statement type:
