mkdocstrings / shell

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

Home Page:https://mkdocstrings.github.io/shell

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

mkdocstrings-shell

documentation gitpod gitter

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.

About

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

https://mkdocstrings.github.io/shell

License:ISC License


Languages

Language:Python 88.1%Language:Shell 10.4%Language:Makefile 1.2%Language:Dockerfile 0.3%