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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_simple_plugin-4.0.2.tar.gz.
File metadata
- Download URL: mkdocs_simple_plugin-4.0.2.tar.gz
- Upload date:
- Size: 19.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d74079bbcb2b4dc7f25721737cf32df6490afb026a086d306054bd9088b906f2
|
|
| MD5 |
f41a28e7cc5e867671c883376229c30a
|
|
| BLAKE2b-256 |
08f949dfce0cba2812d278802130263b1cba4e0ae203d9d2c93ceac3f307ed2f
|
Provenance
The following attestation bundles were made for mkdocs_simple_plugin-4.0.2.tar.gz:
Publisher:
release.yml on athackst/mkdocs-simple-plugin
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_simple_plugin-4.0.2.tar.gz -
Subject digest:
d74079bbcb2b4dc7f25721737cf32df6490afb026a086d306054bd9088b906f2 - Sigstore transparency entry: 2453372976
- Sigstore integration time:
-
Permalink:
athackst/mkdocs-simple-plugin@10927fad0f7b0ad2bd26e4d69a332deaa90479ff -
Branch / Tag:
refs/tags/v4.0.2 - Owner: https://github.com/athackst
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@10927fad0f7b0ad2bd26e4d69a332deaa90479ff -
Trigger Event:
release
-
Statement type:
File details
Details for the file mkdocs_simple_plugin-4.0.2-py3-none-any.whl.
File metadata
- Download URL: mkdocs_simple_plugin-4.0.2-py3-none-any.whl
- Upload date:
- Size: 22.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1ec575e75a991192b1fe87388dac1091bbd736b7e2f7692b86253a23b263a8f2
|
|
| MD5 |
8030421094febb6f45fae572799a7d27
|
|
| BLAKE2b-256 |
84ff1ef515b682c95c76e9f1f1950b947bb4567787bb4908d2ee1adbfa6081af
|
Provenance
The following attestation bundles were made for mkdocs_simple_plugin-4.0.2-py3-none-any.whl:
Publisher:
release.yml on athackst/mkdocs-simple-plugin
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_simple_plugin-4.0.2-py3-none-any.whl -
Subject digest:
1ec575e75a991192b1fe87388dac1091bbd736b7e2f7692b86253a23b263a8f2 - Sigstore transparency entry: 2453373005
- Sigstore integration time:
-
Permalink:
athackst/mkdocs-simple-plugin@10927fad0f7b0ad2bd26e4d69a332deaa90479ff -
Branch / Tag:
refs/tags/v4.0.2 - Owner: https://github.com/athackst
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@10927fad0f7b0ad2bd26e4d69a332deaa90479ff -
Trigger Event:
release
-
Statement type:
