ProperDocs is a fork of MkDocs, aiming to be a complete drop-in replacement for it. We do not intend to make any breaking changes, but rather focus on bug fixes and incremental features. The fork was necessary because development of the original MkDocs project was abandoned.
Please see our statement about forking MkDocs and how to migrate to ProperDocs.
New users can get started using the documentation.
ProperDocs is a static site generator intended for project documentation. Source files are written in Markdown and converted to static HTML during the build process. This can then be deployed to any basic webserver (most commonly, GitHub Pages).
Project configuration is defined in a YAML configuration file (properdocs.yml). This file specifies the documentation structure, theme configuration, and optional plugin settings.
ProperDocs is extensible through plugins, themes and Python-Markdown extensions. You can browse them in our catalog.
Our own documentation uses ProperDocs. Examples and instructions on how to get started can be found there.
If you're coming from MkDocs, check our message welcoming MkDocs users.
If you need help, do not hesitate to get in contact with the community!
-
To report a bug or make a feature request about core ProperDocs functionality, open an Issue on GitHub.
-
For questions and high-level discussions, use Discussions on GitHub.
Note that typically we will not be familiar with features of third-party plugins, so questions about them should probably go to their specific repository.
But we definitely want to hear in case there are any compatibility problems versus MkDocs. -
For small questions of any kind, a good option is the Discord server.
We welcome contributions from the community.
Details are described in the Contributing Guide - including the development setup, coding guidelines and contribution workflow.
All participants in the ProperDocs project are expected to follow the PSF Code of Conduct.
ProperDocs is distributed under the BSD-2-Clause license.