GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - mkdocstrings/shell: A shell scripts/libraries handler for mkdocstrings.

BranchesTags
Open more actions menu

Latest commit

 

History

32 Commits
32 Commits

Folders and files

NameName
Last commit message
Last commit date
.github
.github
 
 
config
config
 
 
docs
docs
 
 
scripts
scripts
 
 
src/mkdocstrings_handlers/shell
src/mkdocstrings_handlers/shell
 
 
tests
tests
 
 
.copier-answers.yml
.copier-answers.yml
 
 
.envrc
.envrc
 
 
.gitignore
.gitignore
 
 
CHANGELOG.md
CHANGELOG.md
 
 
CODE_OF_CONDUCT.md
CODE_OF_CONDUCT.md
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
LICENSE
LICENSE
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
duties.py
duties.py
 
 
mkdocs.yml
mkdocs.yml
 
 
pyproject.toml
pyproject.toml
 
 

Repository files navigation

mkdocstrings-shell

ci documentation pypi version gitter

A shell scripts/libraries handler for mkdocstrings. It uses Shellman to collect documentation from shell scripts.

Installation

pip install mkdocstrings-shell

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.

Sponsors

Bronze sponsors

Nixtla


ofek samuelcolvin tlambert03 ssbarnea femtomc FastAPI cmarqu kolenaIO ramnes machow BenHammersley trevorWieland MarcoGorelli analog-cbarber OdinManiac rstudio-sponsorship schlich butterlyn livingbio NemetschekAllplan EricJayHartman 15r10nk activeloopai roboflow RapidataAI rodolphebarbanneau theSymbolSyndicate blakeNaccarato ChargeStorm Cusp-AI

And 4 more private sponsor(s).

About

A shell scripts/libraries handler for mkdocstrings.

mkdocstrings.github.io/shell/

Topics

bashmkdocstringsmkdocstrings-handlershshellzsh

Resources

Readme
ISC license

Code of conduct

Code of conduct

Contributing

Contributing
Activity
Custom properties

Stars

5 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

Sponsor this project

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.