MARKDOWN-IT(1)

๐Ÿ“ฆ version 4.2.0, in ubuntu stonking

๐Ÿ’– MARKDOWN-IT(1) ๐Ÿ’–

okay bestie, welcome to the markdown-it manual page โ€” user commands edition, she's a whole vibe, she's from the markdown-it-py girlies, dated 2026-05-13, and she is literally just here to turn your Markdown into HTML. no cap.


โœจ NAME โœจ

markdown-it โ€” parse Markdown and write HTML ๐Ÿฆ‹


๐ŸŒธ SYNOPSIS ๐ŸŒธ

fr fr, here's how you call her:

markdown-it [OPTIONS] [FILE...]
markdown-it --stdin [OPTIONS]

๐Ÿ’… DESCRIPTION ๐Ÿ’…

markdown-it converts Markdown to HTML using markdown-it-py. it's giving โœจconverterโœจ and honestly? she ate.

if you hand her one or more FILE arguments, every single file gets read and rendered straight to standard output. like, she's serving each one, okay?

if you set --stdin, she reads the Markdown from standard input and renders it to standard output. piped girlie behavior, we love her ๐Ÿซถ

but if there are no files AND no --stdin? she switches into interactive mode โ€” that's REPL-style input, bestie, she'll start talking back to you ๐Ÿ˜ญ


๐Ÿ‘‘ OPTIONS ๐Ÿ‘‘

  • --stdin โ€” read Markdown from standard input. the humble icon. the main character of safe scripting ๐ŸŒˆ
  • -v, --version โ€” show version information and exit. quick lil flex, then she's out ๐Ÿ’…
  • -h, --help โ€” show help text and exit. exactly what it says on the tin ๐ŸŽ€

๐Ÿšจ SAFE USAGE ๐Ÿšจ

bestie. listen. this one matters.

to use markdown-it as a non-interactive filter, always pass --stdin. periodt.

do not rely on implicit stdin redirection like this:

markdown-it < input.md

why?? because that form enters interactive mode, writes prompts to standard output ๐Ÿ˜ญ, and can produce unexpected HTML output. like the HTML equivalent of a jumpscare ๐Ÿ’€

use this instead:

markdown-it --stdin < input.md > output.html

see how much better that feels? immaculate. no notes โœจ


๐Ÿงš EXAMPLES ๐Ÿงš

render a file, classic behavior:

markdown-it README.md > README.html

render multiple files (concatenated output, she's stacking them like a fit ๐Ÿ‘‘):

markdown-it header.md body.md footer.md > page.html

render piped input, the safe way:

cat README.md | markdown-it --stdin > README.html

๐Ÿ“ SEE ALSO ๐Ÿ“

ngl, this page didn't list any SEE ALSO references, but you can always run markdown-it --help if you need her to introduce herself again ๐Ÿซถ


okay that's the whole page, you're officially educated, i'm so proud of you ๐Ÿ’œ

signing off: this one came from markdown-it-py, version dated 2026-05-13, and she's a user-commands kind of girl โ€” and the manual name is literally right there in the title, MARKDOWN-IT(1). slay. bye bestie! ๐ŸŒธโœจ

๐Ÿ“ฆ where this page comes from