{"repo":"khalidx/runbook","free":true,"listed":false,"github":"https://github.com/khalidx/runbook","clone":"git clone https://github.com/khalidx/runbook.git","description":"Executable markdown documents that you can run, template, and share!","language":"TypeScript","stars":46,"topics":["code-blocks","markdown","runbook","runnable"],"license":"MIT","category":"productivity","readme_excerpt":"runbook Executable markdown documents that you can run, template, and share! quickstart The USAGE.md file is a runnable markdown document. Check it for some usage examples. commands 📂 ls 🚀 run 🌐 serve 💁 help 📂 runbook ls Lists all commands found in documents in the current directory. It discovers files that end in .md , parses them, and finds all fenced code blocks in the file. It returns a list of \"commands\", which are any fenced code blocks that are annotated with a language + a name. Check out the examples below. bash \"hello\" echo \"Hello!\" bash \"two plus two\" echo $((2 + 2)) Running runbook ls would output a command list like the following: Code blocks that are not annotated with a supported runtime and a quoted name will be ignored by runbook. 🚀 runbook run Runs the specified command. The command must be specified in a markdown document in the current directory. For example, to run the \"hello\" command shown above, type: 🌐 runbook serve Starts up a server and automatically opens the browser to a page that displays all discovered documentation and commands. 💁 runbook help Shows what you can do with the runbook CLI. features - define and document reusable commands in your favorite language, with many currently supported - list all commands found in markdown documents in the current directory with runbook ls - run a specific command from a document with runbook run - commands can be templated with arguments using handlebars {{ }} syntax - commands can be overloaded - ","default_branch":null,"files":null,"tree":[],"storefront":"/r/khalidx","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/khalidx/runbook/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}