MARKDOWN(1)

💅 MARKDOWN(1) 💅

ok so this is the markdown page from the General Commands Manual — yes, bestie, the whole manual section, we're being fancy today 🎀 — and it's literally your text-to-html glow-up machine.

---

✨ NAME ✨

markdown — text to html conversion tool 🦋

---

🌸 SYNOPSIS 🌸

markdown [-d] [-T] [-V] [-b url-base] [-C prefix] [-F bitmap] [-f flags]
         [-n] [-o file] [-S] [-s text] [-t text] [-toc] [textfile]

---

💖 DESCRIPTION 💖

okay so the markdown utility reads the markdown(7)-formatted textfile (or stdin if you didn't specify one, no pressure 💅), compiles it, and writes the html output to stdout. that's it. that's the whole vibe. ✨

The options are as follows:

• -b url-base — links in the source that begin with / get prefixed with url-base in the output. slay, relative links. 🔗
• -C — when you're processing markdown extra-style footnotes, use the given prefix instead of the default of fn. yes, it takes a prefix (that's the prefix up in the synopsis, keep up bestie 🫶).
• -d — instead of writing the html file, dump a parse tree to stdout. literally the raw tea, no filter. 🌳
• -f flags — set or clear various translation flags. the flags are in a comma-delimited list, with an optional + (enable), - (disable), or no (disable) lprefix on each flag. (yes, "lprefix". that's what it says. i don't make the rules 💀)
  • links — allow links.
  • image — allow images.
  • smarty — enable smartypants.
  • pants — enable smartypants.
  • html — allow raw html.
  • strict — disable superscript, strikethrough & relaxed emphasis.
  • ext — enable pseudo-protocols.
  • cdata — generate code for xml ![CDATA[...]].
  • superscript — enable superscript processing.
  • emphasis — emphasis happens everywhere.
  • tables — don't process PHP Markdown Extra tables.
  • del — enable ~~strikethrough~~.
  • strikethrough — enable ~~strikethrough~~.
  • toc — enable table-of-contents processing.
  • 1.0 — compatibility with MarkdownTest_1.0
  • autolink — make http://foo.com a link even without <>.
  • safelink — paranoid check for link protocol.
  • header — process pandoc-style header blocks.
  • tabstop — expand tabs to 4 spaces.
  • divquote — allow >%class% blocks.
  • alphalist — allow alphabetic lists.
  • definitionlist — allow definition lists at all (default). use dldiscount and dlextra to control which syntaxes are respected.
  • dldiscount — enable discount-style definition lists (default).
  • dlextra — enable extra-style definition lists (not default). both styles may be enabled simultaneously.
  • footnote — allow markdown extra-style footnotes.
  • style — extract <style> blocks from the output.
  • fencedcode — allow fenced code blocks (not default).
  • idanchor — use id= anchors for table-of-contents links instead of <a name=/> (not default).
  • githubtags — allow underscore and dash in passed through element names (not default).
  • urlencodedanchor — use url-encoded chars for multibyte and nonalphanumeric chars rather than dots in toc links.

as an example, the option -f nolinks,smarty tells markdown to not allow <a tags, and to do smarty pants processing. iykyk 💅

• -F bitmap — set translation flags. bitmap is a bit map of the various configuration options described in markdown(3) (the flag values are defined in mkdio.h). yes it's a bitmap. yes you need the header. 🧚
• -n — don't write generated html. generating nothing, iconic. 🙈
• -o file — write the generated html to file. 🍓
• -S — output <style> blocks.
• -V — show the version# and compile-time configuration data.
  • if the version includes the string DEBUG, markdown was configured with memory allocation debugging. 💀
  • if the version includes the string TAB, markdown was configured to use the specified tabstop.
• -VV — show the version#, the compile-time configuration, and the run-time configuration. double V, double the lore. 👑
• -t text — use mkd_text(3) to format text instead of processing stdin with the markdown(3) function.
• -T — if run with the table-of-content flag on, dump the table of contents before the formatted text.
• -s text — use the markdown(3) function to format text.
• -toc — set the table-of-content flag, then dump the table of contents before the formatted text (a shorthand for --T --toc)

---

🌈 RETURN VALUES 🌈

The markdown utility exits 0 on success, and >0 if an error occurs. zero is the good one, bestie. ✨

---

🦋 SEE ALSO 🦋

markdown(3), markdown(7), mkd-extensions(7). go read them, they're giving lore. 📚

---

💜 AUTHOR 💜

David Parsons (orc@pell.portland.or.us) — the main character who made this happen. 🫶

---

ok that's the whole page, no cap, nothing skipped. run it, love it, -toc it. 💅✨

and the cute sign-off: this whole thing is dated January 7, 2008 and it lives under the MASTODON source/version line — yes, that's the version info at the bottom, we're calling it a vintage icon. 🎀