Metadata-Version: 2.4
Name: mkdocstrings-sh
Version: 0.0.3
Summary: A Sh handler for mkdocstrings.
Author-Email: Kamil Cukrowski <kamilcukrowski@gmail.com>
License-Expression: ISC
License-File: LICENSE
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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Project-URL: Homepage, https://kamilcuk.github.io/mkdocstrings-sh
Project-URL: Documentation, https://kamilcuk.github.io/mkdocstrings-sh
Project-URL: Changelog, https://kamilcuk.github.io/mkdocstrings-sh/changelog
Project-URL: Repository, https://github.com/kamilcuk/mkdocstrings-sh
Project-URL: Issues, https://github.com/kamilcuk/mkdocstrings-sh/issues
Project-URL: Discussions, https://github.com/kamilcuk/mkdocstrings-sh/discussions
Project-URL: Gitter, https://gitter.im/mkdocstrings-sh/community
Project-URL: Funding, https://github.com/sponsors/kamilcuk
Requires-Python: >=3.9
Requires-Dist: mkdocstrings>=0.18
Description-Content-Type: text/markdown

# mkdocstrings-sh

[![ci](https://github.com/kamilcuk/mkdocstrings-sh/workflows/ci/badge.svg)](https://github.com/kamilcuk/mkdocstrings-sh/actions?query=workflow%3Aci)
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://kamilcuk.github.io/mkdocstrings-sh/)
[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-sh.svg)](https://pypi.org/project/mkdocstrings-sh/)

A Sh handler for mkdocstrings.

This is a project unrelated to mkdocstrings-shell project. Maing it mkdocstrings-sh causes confusion with mkdocstrings-shell.
I do not intent to compete with the project. Just my documentation goals are different then mkdocstrings-shell. The features and style by mkdocstrings-shell were not in line with what I wanted. I decided to write my own library. This is the result.

See the generated mkdocs pages in github pages for documentation. <https://kamilcuk.github.io/mkdocstrings-sh/>

See examples/ page in github pages. There are examples with all the syntax and reference of the available tags.


## Installation

```bash
pip install mkdocstrings-sh
```

## Usage:

With the following header file:

```
--8<-- "docs/examples/readme.sh"
```

Generate docs for this file with this instruction in one of your Markdown page:

```
::: path/to/script
```

This will generate the following HTML:

::: docs/examples/readme.sh
