NAME¶

runmd - run code in your markdown and back annotate it with output

SYNOPSIS¶

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

DESCRIPTION¶

run-md is a Node.js command-line utility that executes Markdown files as runnable documents. Code blocks inside the Markdown file are detected, extracted, and executed in the order they appear, and back anotated in the output. This allows Markdown files to serve as executable tutorials, reproducible examples, or lightweight literate programs.

By default, only fenced code blocks tagged with a supported language (such as javascript) are executed. Other blocks are ignored unless explicitly enabled.

OPTIONS¶

--output=output_file

Write the rendered HTML to the specified file instead of standard output.

--watch

Watch the input file for changes and re-render automatically whenever the file is modified.

--lame

Suppress the attribution footer normally added to the rendered output.

SEE ALSO¶

nodejs(1),

AUTHOR¶

Written and maintained by the Debian Javascript team.