{"repo":"ProperDocs/properdocs","free":true,"listed":false,"github":"https://github.com/ProperDocs/properdocs","clone":"git clone https://github.com/ProperDocs/properdocs.git","description":null,"language":"Python","stars":282,"topics":["markdown","mkdocs","documentation","properdocs","static-site-generator"],"license":null,"category":"docs-static-sites","readme_excerpt":"ProperDocs Background 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 . Description 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. Support and discussions 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 ","default_branch":null,"files":null,"tree":[],"storefront":"/r/ProperDocs","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ProperDocs/properdocs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}