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.
Project configuration is defined in a YAML configuration file (properdocs.yml). This file specifies the documentation structure, theme configuration, and optional plugin settings.
ProperDocs supports extension through plugins, themes and Markdown extensions.
For usage instructions and examples, see the Documentation.
Current functionality includes:
- Conversion of Markdown source files into static HTML pages
- YAML-based configuration
- Plugin system for extending functionality
- Support for Markdown extensions
- Support for third-party themes
- Static output suitable for deployment on standard web servers
Additional functionality is available through plugins.
If you encounter problems while using ProperDocs, the following resources are available:
- For questions and high-level discussions, use Discussions on GitHub.
- For small questions, a good alternative is the Discord server.
- To report a bug or make a feature request, open an Issue on GitHub.
Support is generally limited to core ProperDocs functionality. Issues related to third-party themes, plugins or extensions should normally be reported to the maintainers of those projects.
Questions about such components may still be discussed in chat.
Contributions are welcome.
For development setup, coding guidelines and contribution workflow, see the Contributing Guide.
All participants in the ProperDocs project are expected to follow the PSF Code of Conduct.
ProperDocs is distributed under the BSD-2-Clause license.
