ProperDocs
Project documentation with Markdown
ProperDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions.
Please see the Documentation for an introductory tutorial and a full user guide.
Features
- Build static HTML files from Markdown files.
- Use Plugins and Markdown Extensions to enhance ProperDocs.
- Use third party themes or create your own.
- Publish your documentation anywhere that static files can be served.
- Much more!
Support
If you need help with ProperDocs, do not hesitate to get in contact with us!
- 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.
Please note that we may only provide
support for problems/questions regarding core features of ProperDocs. Any
questions or bug reports about features of third-party themes, plugins,
extensions or similar should be made to their respective projects.
But, such questions are not banned from the [chat room].
Make sure to stick around to answer some questions as well!
Links
Contributing to ProperDocs
The ProperDocs project welcomes, and depends on, contributions from developers and users in the open source community. Please see the Contributing Guide for information on how you can help.
Code of Conduct
Everyone interacting in the ProperDocs project's codebases, issue trackers, and discussion forums is expected to follow the PyPA Code of Conduct.
License
1 maintainer
Metadata
1 maintainer
Release files for properdocs 1.6.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| properdocs-1.6.7.tar.gz | 276.1 kB | With provenance | Details for properdocs-1.6.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| properdocs-1.6.7-py3-none-any.whl | Python 3 | none | any | Details for properdocs-1.6.7-py3-none-any.whl |
Total release size: 501.5 kB
Release files / properdocs-1.6.7.tar.gz
| Download URL | properdocs-1.6.7.tar.gz |
|---|---|
| Size | 276.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
adc7b16e562890af0e098a7e5b02e3a81c20894a87d6a28d345c9300de73c26e
|
|
BLAKE2b-256 checksum How to use checksums |
ec29f27a4e1eddf72ed3db6e47818fbafe6debbf09fd7051f9c1a007239b46ef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 20, 2026.
Transparency logRelease files / properdocs-1.6.7-py3-none-any.whl
| Download URL | properdocs-1.6.7-py3-none-any.whl |
|---|---|
| Size | 225.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6fa0cfa2e01bf338f684892c8a506cf70ea88ae7f3479c933b6fa20168101cbd
|
|
BLAKE2b-256 checksum How to use checksums |
bd4dfc923f5c85318ee8cc903566dc4e0ebe41b2dfc1d2ecf5546db232397ed6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 20, 2026.
Transparency logSecurity for properdocs 1.6.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for properdocs-1.6.7.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 20, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
