https://github.com/mkdocstrings/shell

A shell scripts/libraries handler for mkdocstrings. Only available to sponsors.
https://github.com/mkdocstrings/shell

bash mkdocstrings mkdocstrings-handler sh shell zsh

Last synced: 4 months ago
JSON representation

A shell scripts/libraries handler for mkdocstrings. Only available to sponsors.

• Host: GitHub
• URL: https://github.com/mkdocstrings/shell
• Owner: mkdocstrings
• Created: 2023-09-04T09:35:05.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-21T22:17:49.000Z (over 1 year ago)
• Last Synced: 2024-03-21T23:29:55.778Z (over 1 year ago)
• Topics: bash, mkdocstrings, mkdocstrings-handler, sh, shell, zsh
• Homepage: https://mkdocstrings.github.io/shell
• Size: 505 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# mkdocstrings-shell

[![ci](https://github.com/mkdocstrings/shell/workflows/ci/badge.svg)](https://github.com/mkdocstrings/shell/actions?query=workflow%3Aci)

[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/shell/)

[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-shell.svg)](https://pypi.org/project/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

```bash

pip install mkdocstrings-shell

```

## 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.