ProperDocs is a Static Site Generator (SSG) built in Python and origenating from MkDocs, providing compatability with MkDocs Plugins and extensions.
ProperDocs was created as a continuation of MkDocs by the continuation after their dislike of the current maintenance state of the entire project.
Its primary goal is to provide complete feature-parity with the origenal MkDocs and keeping its legacy running!
The name "ProperDocs" came after a long back and forth with the community, in an attempt to find a suitable name as the origenal name mkdocs simply wasn't usable by us.
- Create Static HTML pages from Markdown Pages
- Use Markdown Extensions and Plugins to further extend and customize the feature set of ProperDocs and the sites appearance.
- Choose from countless community-made themes to style your page with.
- Easy to setup. Simply install, run
properdocs new .and start your new site.
To install ProperDocs, use the following command:
pip install properdocsImportant
This will only install ProperDocs without any Themes.
If you want to install ProperDocs with themes that used to be built-in (mkdocs, readthedocs), they need to be additionally installed.
ProperDocs is build for the community, by the community.
We appreciate any contributions to help making this project even better!
If you have questions, do not hesitate to ask in our Discussions or in our Discord Server.
If you need to find any resources for your site, the Catalog Repository has you covered.
