{"id":15211169,"url":"https://github.com/mkdocstrings/shell","last_synced_at":"2025-12-14T19:58:19.640Z","repository":{"id":229077306,"uuid":"686948128","full_name":"mkdocstrings/shell","owner":"mkdocstrings","description":"A shell scripts/libraries handler for mkdocstrings. Only available to sponsors.","archived":false,"fork":false,"pushed_at":"2024-03-21T22:17:49.000Z","size":517,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-03-21T23:29:55.778Z","etag":null,"topics":["bash","mkdocstrings","mkdocstrings-handler","sh","shell","zsh"],"latest_commit_sha":null,"homepage":"https://mkdocstrings.github.io/shell","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdocstrings.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-09-04T09:35:05.000Z","updated_at":"2024-03-21T23:29:56.860Z","dependencies_parsed_at":"2024-03-21T23:29:56.801Z","dependency_job_id":"331e9ede-e307-4fc4-8999-fbd4f48e4375","html_url":"https://github.com/mkdocstrings/shell","commit_stats":null,"previous_names":["mkdocstrings/shell"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fshell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fshell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fshell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fshell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocstrings","download_url":"https://codeload.github.com/mkdocstrings/shell/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242940018,"owners_count":20209883,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","mkdocstrings","mkdocstrings-handler","sh","shell","zsh"],"created_at":"2024-09-28T08:20:21.595Z","updated_at":"2025-12-14T19:58:19.600Z","avatar_url":"https://github.com/mkdocstrings.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocstrings-shell\n\n[![ci](https://github.com/mkdocstrings/shell/workflows/ci/badge.svg)](https://github.com/mkdocstrings/shell/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/shell/)\n[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-shell.svg)](https://pypi.org/project/mkdocstrings-shell/)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#shell:gitter.im)\n\nA shell scripts/libraries handler for mkdocstrings.\nIt uses [Shellman](https://github.com/pawamoy/shellman)\nto collect documentation from shell scripts.\n\n## Installation\n\n```bash\npip install mkdocstrings-shell\n```\n\n## Configuration\n\nIn MkDocs configuration file:\n\n```yaml title=\"mkdocs.yml\"\nplugins:\n- mkdocstrings:\n    default_handler: shell  # optional\n```\n\nThe handler does not offer any option yet.\n\n## Usage\n\nUse *mkdocstrings* syntax to inject documentation for a script:\n\n```md\n::: relative/path/to/script\n    handler: shell  \n```\n\nSpecifying `handler: shell` is optional if you declared `shell`\nas default handler in mkdocs.yml.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fshell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocstrings%2Fshell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fshell/lists"}