Metadata-Version: 2.1
Name: mkdocstrings-shell
Version: 0.0.1
Summary: A shell scripts/libraries handler for mkdocstrings.
Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
License: ISC
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Project-URL: Homepage, https://mkdocstrings.github.io/shell
Project-URL: Documentation, https://mkdocstrings.github.io/shell
Project-URL: Changelog, https://mkdocstrings.github.io/shell/changelog
Project-URL: Repository, https://github.com/mkdocstrings/shell
Project-URL: Issues, https://github.com/mkdocstrings/shell/issues
Project-URL: Discussions, https://github.com/mkdocstrings/shell/discussions
Project-URL: Gitter, https://gitter.im/mkdocstrings/shell
Project-URL: Funding, https://github.com/sponsors/pawamoy
Requires-Python: >=3.8
Requires-Dist: mkdocstrings>=0.18
Requires-Dist: shellman>=1.0.0
Description-Content-Type: text/markdown

# mkdocstrings-shell

[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/shell/)
[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/shell)
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#shell:gitter.im)

A shell scripts/libraries handler for mkdocstrings.
It uses [Shellman](https://github.com/pawamoy/shellman)
to collect documentation from shell scripts.

## Installation

This project is available to sponsors only, through my Insiders program.
See Insiders [explanation](https://mkdocstrings.github.io/shell/insiders/)
and [installation instructions](https://mkdocstrings.github.io/shell/insiders/installation/).

## Configuration

In MkDocs configuration file:

```yaml title="mkdocs.yml"
plugins:
- mkdocstrings:
    default_handler: shell  # optional
```

The handler does not offer any option yet.

## Usage

Use *mkdocstrings* syntax to inject documentation for a script:

```md
::: relative/path/to/script
    handler: shell  
```

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