OMD(1)

πŸ“¦
version 1.3.2 Β· 5 versions
, in debian trixie, ubuntu questing

πŸ’– NAME πŸ’–

okay so bestie, listen β€” omd is a Markdown frontend in pure OCaml. that's it, that's the whole vibe. (it's from the OMD(1) manual, User Commands section, iykyk 🫢)


🌸 DESCRIPTION 🌸

here's how you call her:

omd [options] [inputfile1 .. inputfileN] [options]

yep, options can go literally anywhere, before and after your input files. she's flexible like that. πŸ’…

and now the flag menu, bestie β€” read it, don't skim it, there WILL be a quiz (there will not be a quiz):

  • -o file.html β€” tells her where to put the output. default is stdout, so if you don't say anything she just yells into the terminal. iconic honestly.
  • -- β€” everything after this is treated as input file names, no cap. all remaining arguments, consider them files.
  • -u β€” use standard Markdown style for emph/bold when you're using _. slay.
  • -c β€” ignore any line that starts with !!! (that's 3 or more exclamation points, she counted).
  • -C β€” ignore everything on a line after !!! (again, 3 or more exclamation points).
  • -m β€” output Markdown instead of HTML. yes she can spit Markdown back out. versatile queen.
  • -notags β€” output without the HTML tags.
  • -toc β€” replaces *Table of contents* with the actual table of contents. the way that works?? obsessed.
  • -otoc β€” output only the table of contents. nothing else. just the toc. main character energy.
  • -ts f β€” section for the Table of contents. default is all.
  • -td f β€” Table of contents depth. default is 2.
  • -H β€” protect HTML comments. keep them safe. πŸ›‘οΈ
  • -r l=p β€” register program p as a code highlighter for language l.
  • -R l β€” registers unknown languages to be l instead of void.
  • -nl2br β€” convert new lines to <br/>.
  • -x ext β€” activate extension ext (not yet implemented, so like... manifest it bestie ✨).
  • -l β€” list available extensions ext (also not yet implemented πŸ™ˆ).
  • -b β€” don't check validity of HTML tag names. live dangerously.
  • -s β€” (might not work as expected yet 🫠) Block HTML only in block HTML, inline HTML only in inline HTML (semantics undefined if use both -b and -s).
  • -LHTML β€” List all known HTML tags
  • -LHTMLi β€” List all known inline HTML tags
  • -version β€” Print version.
  • -VS start β€” Set the start token to use to declare a verbatim section. If you use -VE, you must use -VS, and both must be non-empty.
  • -VE end β€” Set the end token to use to declare a verbatim section. If you use -VE, you must use -VS, and both must be non-empty.
  • -w β€” Activate warnings (beta).
  • -W β€” Convert warnings to errors, implies -w (beta).
  • -help β€” Display this list of options
  • --help β€” Display this list of options
🚨 heads up bestie: -x and -l are not yet implemented, -s might not work as expected yet, and -w / -W are beta. also if you run -b and -s together, the semantics are undefined. that's not me being dramatic, that's the manual. don't do it. fr fr. πŸ’€

πŸ¦‹ SEE ALSO πŸ¦‹

the full documentation for omd lives in a Texinfo manual. if info and omd are properly installed at your site, then this command:

info omd

should hand you the complete manual. go get it, you deserve the whole thing. πŸ’œ


and that's a wrap on the omd page, bestie πŸŽ€ this was version omd 1.3.2, dated June 2025, filed under OMD(1). go write some Markdown, you absolute icon πŸ‘‘βœ¨

πŸ“¦ where this page comes from