{"id":16184608,"url":"https://github.com/rmariuzzo/markdown-exec","last_synced_at":"2025-06-14T11:04:25.780Z","repository":{"id":143889147,"uuid":"116300506","full_name":"rmariuzzo/markdown-exec","owner":"rmariuzzo","description":"Execute commands in your Markdown and keep the output.","archived":false,"fork":false,"pushed_at":"2018-01-09T17:22:41.000Z","size":36,"stargazers_count":5,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-26T15:04:21.333Z","etag":null,"topics":["cli","exec","markdown","markdown-parser"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/rmariuzzo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2018-01-04T19:43:04.000Z","updated_at":"2023-04-11T12:31:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"bfb2560e-7bde-4302-8140-f63b536771f4","html_url":"https://github.com/rmariuzzo/markdown-exec","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/rmariuzzo/markdown-exec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariuzzo%2Fmarkdown-exec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariuzzo%2Fmarkdown-exec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariuzzo%2Fmarkdown-exec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariuzzo%2Fmarkdown-exec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rmariuzzo","download_url":"https://codeload.github.com/rmariuzzo/markdown-exec/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariuzzo%2Fmarkdown-exec/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259804841,"owners_count":22913901,"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":["cli","exec","markdown","markdown-parser"],"created_at":"2024-10-10T07:10:43.194Z","updated_at":"2025-06-14T11:04:25.748Z","avatar_url":"https://github.com/rmariuzzo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=center\u003e\n\n![Markdown Exec - Execute commands in your Markdown and keep the output.](.github/banner.svg)\n\n\u003c/div\u003e\n\n# Installation\n\n```shell\nyarn add markdown-exec --global\n```\n\nor\n\n```shell\nnpm install markdown-exec --global\n```\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n# Usage\n\nThe `markdown-exec` command takes one single argument: a file containing [XML Comment API](https://github.com/rmariuzzo/xml-comment-api)'s annotations.\n\n```shell\nmarkdown-exec ./README.md\n```\n\nThe command will process the content of the given file and will search for XML comments that has the following format:\n\n```xml\n\u003c!-- markdown-exec() --\u003e\u003c!-- /markdown-exec --\u003e\n```\n\n## Specify command to execute\n\n**Before:**\n\n```xml\n\u003c!-- markdown-exec(cmd:echo '123') --\u003e\u003c!-- /markdown-exec --\u003e\n```\n\n**After:**\n\n```xml\n\u003c!-- markdown-exec(cmd:echo '123') --\u003e123\u003c!-- /markdown-exec --\u003e\n```\n\n## Use a regular expression to reduce the command output\n\n**Before:**\n\n```xml\n\u003c!-- markdown-exec(cmd:echo 'test123', match:\\d+) --\u003e\u003c!-- /markdown-exec --\u003e\n```\n\n**After:**\n\n```xml\n\u003c!-- markdown-exec(cmd:echo 'test123', match:\\d+) --\u003e123\u003c!-- /markdown-exec --\u003e\n```\n\n## Tests\n\n - `yarn test` - run all tests once.\n - `yarn test -- --watch` - run all tests and watch for changes.\n\n## Development\n\nTo start contributing to this project, please do:\n\n 1. [Fork and clone this repo](https://github.com/rmariuzzo/markdown-exec/fork).\n 2. Do your work.\n 3. Create a PR.\n\n## Releases\n\nTo release this project the following tasks should be done:\n\n 1. Using [np](https://github.com/sindresorhus/np): `np`\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n\u003cdiv align=center\u003e\n\nMade with :heart: by [Rubens Mariuzzo](https://github.com/rmariuzzo).\n\n[MIT License](LICENSE)\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmariuzzo%2Fmarkdown-exec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frmariuzzo%2Fmarkdown-exec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmariuzzo%2Fmarkdown-exec/lists"}