{"id":15057019,"url":"https://github.com/seapagan/mkdocs-run-shell-cmd-plugin","last_synced_at":"2026-01-19T21:33:24.070Z","repository":{"id":176516572,"uuid":"658428855","full_name":"seapagan/mkdocs-run-shell-cmd-plugin","owner":"seapagan","description":"An MkDocs plugin to run shell commands and inject the output into your documents.","archived":false,"fork":false,"pushed_at":"2023-10-17T20:38:42.000Z","size":851,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-24T07:29:12.773Z","etag":null,"topics":["markdown","mkdocs","mkdocs-plugin","python"],"latest_commit_sha":null,"homepage":"https://seapagan.github.io/mkdocs-run-shell-cmd-plugin/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/seapagan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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,"publiccode":null,"codemeta":null}},"created_at":"2023-06-25T18:01:19.000Z","updated_at":"2024-05-25T23:59:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"c2b584a1-8dd9-46dd-ab3e-96930cbf553f","html_url":"https://github.com/seapagan/mkdocs-run-shell-cmd-plugin","commit_stats":null,"previous_names":["seapagan/mkdocs-run-shell-cmd-plugin"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/seapagan/mkdocs-run-shell-cmd-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seapagan%2Fmkdocs-run-shell-cmd-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seapagan%2Fmkdocs-run-shell-cmd-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seapagan%2Fmkdocs-run-shell-cmd-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seapagan%2Fmkdocs-run-shell-cmd-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seapagan","download_url":"https://codeload.github.com/seapagan/mkdocs-run-shell-cmd-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seapagan%2Fmkdocs-run-shell-cmd-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28585515,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T20:45:59.482Z","status":"ssl_error","status_checked_at":"2026-01-19T20:45:41.500Z","response_time":67,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["markdown","mkdocs","mkdocs-plugin","python"],"created_at":"2024-09-24T22:00:40.508Z","updated_at":"2026-01-19T21:33:24.051Z","avatar_url":"https://github.com/seapagan.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs Plugin : `run-shell-cmd` \u003c!-- omit in toc --\u003e\n\n[![PyPI version](https://badge.fury.io/py/mkdocs-run-shell-cmd-plugin.svg)](https://badge.fury.io/py/mkdocs-run-shell-cmd-plugin)\n\nThis is an [MkDocs](https://www.mkdocs.org/) plugin that runs a specified\ncommand (or commands) during the `build` and `serve` process and injects the\ncommand and output into the generated site in a fenced block.\n\nIt's very useful for documenting command-line programs, expecially during\ndevelopment where the command line may change frequently.\n\n**See the [Website][website] for examples and full documentation.**\n\n- [IMPORTANT](#important)\n- [Installation](#installation)\n- [Configuration and Usage](#configuration-and-usage)\n- [License](#license)\n- [TODO](#todo)\n\n## IMPORTANT\n\n  \u003e This plugin allows running arbitrary commands on your system. It does\n  \u003e **NOT** check the command for safety, and it does **NOT** run the command in\n  \u003e a sandbox. However, it does ask you if you want to run each command, and it\n  \u003e does allow you to disable all commands from running again for the duration\n  \u003e of the session. Also commands are not run using a shell, so your environment\n  \u003e variables are not available to the command. Commands are set in the markdown\n  \u003e file, so they are not run unless you build, serve or publish the site. If\n  \u003e you are using a CI/CD pipeline to generate your docs, you should be aware\n  \u003e that some standard commands may be missing or blocked, and the CI will\n  \u003e probably hang due to waiting for input. Generating the docs on a local\n  \u003e machine and then pushing them up to your hosting is probably a better idea.\n\n## Installation\n\nInstall the package with pip:\n\n```bash\npip install mkdocs-run-shell-cmd-plugin\n```\n\nor, if you are using [Poetry](https://python-poetry.org):\n\n```bash\npoetry add mkdocs-run-shell-cmd-plugin --group dev\n```\n\n## Configuration and Usage\n\nSee the [Website][website] for\nfull usage information.\n\n## License\n\nThis is released under the MIT License. See the bundled LICENSE file for more\ndetails.\n\n## TODO\n\nSee [TODO.md](TODO.md) for a list of outstanding tasks or ideas.\n\n[website]: https://seapagan.github.io/mkdocs-run-shell-cmd-plugin/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseapagan%2Fmkdocs-run-shell-cmd-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseapagan%2Fmkdocs-run-shell-cmd-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseapagan%2Fmkdocs-run-shell-cmd-plugin/lists"}