MkDocs Plugin : run-shell-cmd
This is an MkDocs plugin that runs a specified
command (or commands) during the build and serve process and injects the
command and output into the generated site in a fenced block.
It's very useful for documenting command-line programs, expecially during development where the command line may change frequently.
See the Website for examples and full documentation.
IMPORTANT
This plugin allows running arbitrary commands on your system. It does NOT check the command for safety, and it does NOT run the command in a sandbox. However, it does ask you if you want to run each command, and it does allow you to disable all commands from running again for the duration of the session. Also commands are not run using a shell, so your environment variables are not available to the command. Commands are set in the markdown file, so they are not run unless you build, serve or publish the site. If you are using a CI/CD pipeline to generate your docs, you should be aware that some standard commands may be missing or blocked, and the CI will probably hang due to waiting for input. Generating the docs on a local machine and then pushing them up to your hosting is probably a better idea.
Installation
Install the package with pip:
pip install mkdocs-run-shell-cmd-plugin
or, if you are using Poetry:
poetry add mkdocs-run-shell-cmd-plugin --group dev
Configuration and Usage
See the Website for full usage information.
License
This is released under the MIT License. See the bundled LICENSE file for more details.
TODO
See TODO.md for a list of outstanding tasks or ideas.
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-run-shell-cmd-plugin 0.2.0
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_run_shell_cmd_plugin-0.2.0.tar.gz | 5.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_run_shell_cmd_plugin-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.5 kB
Release files / mkdocs_run_shell_cmd_plugin-0.2.0.tar.gz
| Download URL | mkdocs_run_shell_cmd_plugin-0.2.0.tar.gz |
|---|---|
| Size | 5.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d8447009ca6ad3225371db6ac97ed408872efe81a5b648ace679013cb9ba6096
|
|
BLAKE2b-256 checksum How to use checksums |
10611b392f78268bbf5912e132fc9ef32417a58039f1d6681e10b89af9666168
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.0 CPython/3.10.7 Linux/5.19.0-45-generic
|
Release files / mkdocs_run_shell_cmd_plugin-0.2.0-py3-none-any.whl
| Download URL | mkdocs_run_shell_cmd_plugin-0.2.0-py3-none-any.whl |
|---|---|
| Size | 5.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0f8e680e47a8663ccc2315668db5e98c3f4518543205057c957763ecfba1a89b
|
|
BLAKE2b-256 checksum How to use checksums |
b2e9413910f1d5e95195b96bf98a29cef16360bd83118c38e74a3efda963dbf7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.0 CPython/3.10.7 Linux/5.19.0-45-generic
|
Security for mkdocs-run-shell-cmd-plugin 0.2.0
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.
