{"id":20568097,"url":"https://github.com/fvumbaca/mdrun","last_synced_at":"2026-01-30T22:02:25.586Z","repository":{"id":106303238,"uuid":"461641066","full_name":"fvumbaca/mdrun","owner":"fvumbaca","description":"Interactive execution of Markdown documents. Perfect for runbooks or technical labs and tutorials.","archived":false,"fork":false,"pushed_at":"2022-02-21T09:12:01.000Z","size":50,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T22:45:03.551Z","etag":null,"topics":["documentation","incident-response","laboratory","markdown","runbooks","toolkit"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fvumbaca.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":"2022-02-20T23:09:03.000Z","updated_at":"2022-03-27T14:34:59.000Z","dependencies_parsed_at":"2023-06-09T05:30:37.662Z","dependency_job_id":null,"html_url":"https://github.com/fvumbaca/mdrun","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvumbaca%2Fmdrun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvumbaca%2Fmdrun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvumbaca%2Fmdrun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvumbaca%2Fmdrun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fvumbaca","download_url":"https://codeload.github.com/fvumbaca/mdrun/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248643047,"owners_count":21138353,"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":["documentation","incident-response","laboratory","markdown","runbooks","toolkit"],"created_at":"2024-11-16T04:49:19.674Z","updated_at":"2026-01-30T22:02:20.538Z","avatar_url":"https://github.com/fvumbaca.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `mdrun`\n\n\u003e `mdrun` is still very much  under development and not quite ready for serious\nscrutiny (even before considering it for production use). At this stage, I am\nstill experimenting with ideas and experiences to achieve my goals with the\nproject. Nothing here is set in stone and might change overnight.\n\n`mdrun` is a tool for getting the most out of your technical documentation. It\nallows you to live evaluate code blocks in your markdown with _no modification_\nto your documents.\n\n`mdrun` is not just great as a teaching tool or impressing your friends. It can\nalso be used as a powerful runbook and incident response tool by granting\nresponders diagnosis and remediation processes at the click of a button.\n\n\n## Install\n\nInstall `mdrun` from source with the Go tool chain:\n\n```sh\ngo install github.com/fvumbaca/mdrun\n```\n\n## Usage\n\nThe simplest and most common way to use `mdrun` is to just run it from the command line:\n\n```sh\nmdrun\n```\n\nThis will startup a server on your localhost allowing you to browse files in\nthe current directory.\n\n## Still TODO\n\n- Support basic cli flags like `--port`\n- Support metadata at the top of the file in front matter\n- Support required cli-tools to throw errors early if it can even run on the\nsystem\n- Support out-of-the-box containerization??\n- CLI mode will print out the runbook to stdout and prompt before each exec\n- Script mode that will execute markdown as a script\n- Infer language dependencies from code blocks\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffvumbaca%2Fmdrun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffvumbaca%2Fmdrun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffvumbaca%2Fmdrun/lists"}