mkdocs-simple-plugin
This plugin enables you to build a documentation site from markdown interspersed within your repository using mkdocs.
About
You may be wondering why you would want to generate a static site for your project without doing the typical "wiki" thing of consolidating all documentation within a single docs folder or using a single README file.
-
My repository is too big for a single documentation source.
Sometimes it isn't feasible to consolidate all documentation within an upper level
docsdirectory. In general, if your codebase is too large to fit well within a singleincludedirectory, your codebase is also too large for documentation in a singledocsdirectory.Since it's typically easier to keep documentation up to date when it lives as close to the code as possible, it is better to create multiple sources for documentation.
-
My repository is too simple for advanced documentation.
If your codebase is very very large, something like the monorepo plugin might better fit your needs.
For most other medium+ repositories that have grown over time, you probably have scattered documentation throughout your code. By combining all of that documentation while keeping folder structure, you can better surface and collaborate with others. And, let's face it. That documentation is probably all in markdown since Github renders it nicely.
-
I want a pretty documentation site without the hassle.
Finally, you may be interested in this plugin if you have a desire for easy-to-generate stylized documentation. This plugin lets you take documentation you may already have -- either in markdown files or in your code -- and formats them into a searchable documentation website. You can keep your documentation where it is (thank you very much).
See mkdocs-simple-plugin for usage.
Contributing
See the contributing guide
License
This software is licensed under Apache 2.0
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-simple-plugin 4.0.2
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 | |
|---|---|---|---|---|
| mkdocs_simple_plugin-4.0.2.tar.gz | 19.3 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_simple_plugin-4.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.8 kB
Release files / mkdocs_simple_plugin-4.0.2.tar.gz
| Download URL | mkdocs_simple_plugin-4.0.2.tar.gz |
|---|---|
| Size | 19.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d74079bbcb2b4dc7f25721737cf32df6490afb026a086d306054bd9088b906f2
|
|
BLAKE2b-256 checksum How to use checksums |
08f949dfce0cba2812d278802130263b1cba4e0ae203d9d2c93ceac3f307ed2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 13, 2026.
Transparency logRelease files / mkdocs_simple_plugin-4.0.2-py3-none-any.whl
| Download URL | mkdocs_simple_plugin-4.0.2-py3-none-any.whl |
|---|---|
| Size | 22.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1ec575e75a991192b1fe87388dac1091bbd736b7e2f7692b86253a23b263a8f2
|
|
BLAKE2b-256 checksum How to use checksums |
84ff1ef515b682c95c76e9f1f1950b947bb4567787bb4908d2ee1adbfa6081af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Aug 13, 2026.
Transparency logSecurity for mkdocs-simple-plugin 4.0.2
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 mkdocs_simple_plugin-4.0.2.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 Aug 13, 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.
