MKD2HTML(1)

✨ MKD2HTML — the manual, but make it cute ✨

okay bestie, welcome to mkd2html, the little utility that turns your markdown document into (X)HTML 💖 it's a general commands manual page, and I'm about to walk you through every single detail, no cap.

🌸 NAME 🌸

mkd2html — convert a markdown document into (X)HTML 🦋

🎀 SYNOPSIS 🎀

mkd2html [-dHhmnx] [file]

💅 DESCRIPTION 💅

so the mkd2html utility reads file and generates (X)HTML input from markdown source ✨ and if you don't specify file? it just takes it from standard input. lowkey iconic behavior.

by default, mkd2html implies -H and -m options 👑 that's just the vibe it's on.

the options are as follows, and yes we're going through all of them:

🌈 OPTIONS 🌈

• -d, --discount — enable Discount extensions 💀 and there are a lot of them:
  • image size specification, by appending =(width)x(height) to the link 🖼️
  • pseudo-protocols in links:
    • abbr:description for <abbr title="description">...</abbr>
    • class:name for <span class="name">...</span>
    • id:name for <span id="name">...</span>
    • raw:text for verbatim unprocessed text inclusion
  • class blocks: blockquotes beginning with %class% will be rendered as a div of the given class(es) 💜
  • and PHP-Markdown-like tables, periodt 🍓
• -H, --html — output HTML, with self-closing tags like: <br> ✨
• -h, --help — display help text 🫶 (the classic, the beloved)
• -m, --markdown — disable all extensions and use strict markdown syntax 🎀 no extras, no frills, just the basics bestie
• -n, --natext — enable Discount extensions and Natasha's own extensions 😭 this one's stacked:
  • id attribute for headers, using the syntax id#Header text
  • class attribute for paragraphs, by putting class name(s) between parenthesis at the very beginning of the paragraph
  • <ins> and <del> spans, using respectively ++ and -- as delimiters (with emphasis-like restrictions, i.e. an opening delimiter cannot be followed by a whitespace, and a closing delimiter cannot be preceded by a whitespace) ⚠️ so watch your spacing fr fr
  • plain <span> without attribute, using emphasis-like delimiter |
• -x, --xhtml — output XHTML, with self-closing tags like: <br /> 💖

👑 EXIT STATUS 👑

the mkd2html utility exits 0 on success, and >0 if an error occurs 💀 so if you get a nonzero number, something went wrong, bestie.

🦋 SEE ALSO 🦋

mkd2latex(1), mkd2man(1) 🌸 go read those too, they're the whole friend group

💜 AUTHORS 💜

mkd2html was written by Natasha "Kerensikova" Porte <natacha@instinctive.eu> 👑

the manual page was originally written by Massimo Manghi <mxmanghi@apache.org>, and rewritten to mdoc format by Svyatoslav Mishyn <juef@openmailbox.org> 🌟

and that's the whole page, bestie 💅 this Debian build is dated March 1, 2016, and honestly? it ate. slay, go convert some markdown ✨🎀🦋