RUNMD(1)

πŸ“¦ version 1.4.1, in ubuntu stonking

✨ NAME ✨

runmd β€” run code in your markdown and back annotate it with output πŸ’…

okay so like, welcome to runmd(1), bestie 🫢 this is one of the User Commands, and she's about to change your whole relationship with documentation, no cap.


🌸 SYNOPSIS 🌸

runmd [--output=output_file] [--watch] [--lame] input_file

that's it. that's the whole vibe check. one input file, three little flags, infinite slay.


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so run-md is a Node.js command-line utility and her whole thing β€” her main character energy β€” is that she executes Markdown files as runnable documents. yes fr fr. your .md file can just… run. πŸ’–

Here's the tea on how she does it: code blocks inside the Markdown file get detected, extracted, and executed in the order they appear, and then they get back annotated in the output. So the answer your code produced just slides right back into the doc next to the code itself. iconic behavior honestly.

the way that this lets Markdown files serve as:

  • executable tutorials πŸ“š
  • reproducible examples πŸ”
  • lightweight literate programs ✨

like?? she ate. πŸ‘‘

By default, only fenced code blocks tagged with a supported language (such as javascript) are executed. Everything else is ignored β€” unless you explicitly enable it. so if your block is just vibing there untagged, she's gonna walk right past it. no offense, it just wasn't invited. πŸ™ˆ


πŸŽ€ OPTIONS πŸŽ€

  • --output=output_file β€” write the rendered HTML to the specified file instead of standard output. so instead of yelling the HTML into your terminal, she writes it down somewhere nice and keeps it. πŸ’Ύ
  • --watch β€” watch the input file for changes and re-render automatically whenever the file is modified. she literally never stops paying attention to you. obsessive in a helpful way. πŸ‘€πŸ”₯
  • --lame β€” suppress the attribution footer normally added to the rendered output. (the flag is named that way, not me, i would never. but if you don't want the footer, this is the button. 🫣)

πŸ’œ SEE ALSO πŸ’œ

yes bestie there's a trailing comma in the source, she's a little quirky, we love her anyway. 🌈


πŸ‘‘ AUTHOR πŸ‘‘

Written and maintained by the Debian Javascript team. absolute legends, protect them at all costs. 🫢


πŸ’€ quick reminder since we're being responsible: only fenced code blocks tagged with a supported language (like javascript) run by default. everything else is ignored unless explicitly enabled. don't get caught out there running random blocks and being confused, iykyk.

aaaaand that's the whole page, bestie!! this was runmd version 1.0.0, from March 2026, served fresh from the User Commands section of the manual. go run some markdown, you're literally gonna be so good at this. β­πŸ§šπŸ“ byeeeee πŸ’…βœ¨

πŸ“¦ where this page comes from