About prodockit¶
This section is for anyone evaluating or using prodockit who needs to understand its scope, dependencies, support, release history, or legal terms.
prodockit is a Python package for professional and academic documentation built with Zensical. It adds Markdown extensions, website macros, PDF generation, output checks, and project-management commands without requiring a document author to build those pieces independently.
Understand the foundation¶
prodockit builds on Python-Markdown, Zensical, and
PyMdown Extensions.
PyMdown Blocks is a direct foundation, not merely a compatible syntax:
prodockit.steps and prodockit.tree are implemented with its Blocks API and
use the same slash-fenced container model as PyMdown's own blocks. Installing
prodockit therefore installs pymdown-extensions too.
This relationship lets prodockit add specialised document blocks while retaining the nesting, configuration, and rendering conventions familiar to Zensical authors. Start with Numbered steps or Directory trees to see the shared model in use.
Know the project family¶
| Project | Role |
|---|---|
| prodockit-extensions | The Python package, command-line tools, implementation, tests, and this technical reference |
| prodockit-template | The maintained starting project, including annotated GitHub and GitLab publishing automation |
| prodockit-userguide | The task-based guide for people creating and publishing documents with the template |
The template is maintained on GitHub and synchronised to the University of Surrey's GitLab for student use. Projects created from it use the same prodockit package documented here.
Choose where to continue¶
| Page | Use it for |
|---|---|
| Get started | Install prodockit and build a first local site |
| Authoring reference | Add document features to Markdown pages |
| Publish a document | Produce and deploy a website and PDF |
| Support and compatibility | Check maturity, supported versions, platforms, and known constraints |
| Release notes | See new features, fixes, and upgrade actions by version |
| Licence | Read the MIT License governing use, modification, and redistribution |
Repository maintainers should use Maintain prodockit. Developers changing the package itself should use Contributor internals.