Description:

mkdocstringsshell 0.0.1

mkdocstrings-shell



A shell scripts/libraries handler for mkdocstrings.
It uses Shellman
to collect documentation from shell scripts.
Installation
This project is available to sponsors only, through my Insiders program.
See Insiders explanation
and installation instructions.
Configuration
In MkDocs configuration file:
plugins:
- mkdocstrings:
default_handler: shell # optional

The handler does not offer any option yet.
Usage
Use mkdocstrings syntax to inject documentation for a script:
::: relative/path/to/script
handler: shell

Specifying handler: shell is optional if you declared shell
as default handler in mkdocs.yml.

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter