MARKDOWN(3)

📦
version 3.0.2.0 · 2 versions
, in arch rolling, epel 10, epel 9, fedora 43, fedora 44, opensuse-leap 16.0

💖 MARKDOWN(3) — markdown, the iconic library functions manual 💖

okay so bestie, gather round, because today we're talking about markdown — the literal main character of libmarkdown — and she processes Markdown documents. no cap. 🎀

🌸 LIBRARY 🌸

Markdown (libmarkdown, link it with -lmarkdown). she's right there, waiting for you. 🫶

✨ SYNOPSIS ✨

#include <mkdio.h>

MMIOT
*mkd_in(FILE *input, int flags);

MMIOT
*mkd_string(char *string, int size, int flags);

int
markdown(MMIOT *doc, FILE *output, int flags);

💅 DESCRIPTION 💅

these functions convert Markdown documents and strings into HTML, fr fr. markdown() handles a whole entire document, while mkd_text() just does a single string. different vibes, same family. 🌈

so to process a file, you hand a FILE* over to mkd_in(), and if it comes back nonzero you pass that into markdown(), which then writes the converted document to the FILE* you specified. slay. and if your input is already sitting in a string — like, generated input, or a file you opened with mmap(2) — you can feed that string straight into mkd_string() and pass its return value to markdown.(). easy. 💖

Markdown() accepts these flag values (or-ed together if you need to stack them, go off) to restrict how it processes input:

  • MKD_NOLINKS — don't do link processing, block <a> tags. not today. 🚫
  • MKD_NOIMAGE — don't do image processing, block <img>.
  • MKD_NOPANTS — don't run smartypants(). the pants stay off, bestie.
  • MKD_NOHTML — don't allow raw html through AT ALL. screaming, crying, no html.
  • MKD_STRICT — disable superscript and relaxed emphasis. strict era. 😤
  • MKD_TAGTEXT — process text to put inside an html tag (ID=, NAME=, <title>, &tc); no <em>, no <bold>, no html or [] expansion.
  • MKD_NO_EXT — don't allow pseudo-protocols.
  • MKD_CDATA — generate code for xml ![CDATA[...]].
  • MKD_NOSUPERSCRIPT — don't generate superscripts. emphasis happens _everywhere_ 👀
  • MKD_NOTABLES — disallow tables.
  • MKD_NOSTRIKETHROUGH — forbid ~~strikethrough~~.
  • MKD_TOC — do table-of-contents processing. queen behavior. 👑
  • MKD_1_COMPAT — compatibility with MarkdownTest_1.0
  • MKD_AUTOLINK — make http://foo.com into a link even without <>s.
  • MKD_SAFELINK — paranoid check for link protocol.
  • MKD_NOHEADER — don't process header blocks.
  • MKD_TABSTOP — expand tabs to 4 spaces.
  • MKD_NODIVQUOTE — forbid >%class% blocks.
  • MKD_NOALPHALIST — forbid alphabetic lists.
  • MKD_NODLIST — forbid definition lists.
  • MKD_NODLDISCOUNT — disable the discount definition list syntax style.
  • MKD_DLEXTRA — enable the extra definition list syntax style.
  • MKD_EXTRA_FOOTNOTE — enable markdown extra-style footnotes.
  • MKD_NOSTYLE — do not extract (omit) <style/> blocks from the output.
  • MKD_FENCEDCODE — allow fenced code blocks.
  • MKD_IDANCHOR — use id= anchors instead of <a name=/> for table-of-contents links.
  • MKD_GITHUBTAGS — allow underscore and dash in passed through element names.
  • MKD_URLENCODEDANCHOR — use html5 encoding for multibyte and nonalphanumeric characters rather than hex expansion in toc links.

🦋 RETURN VALUES 🦋

markdown() returns 0 on success, 1 on failure. so like, binary. 💀 the mkd_in() and mkd_string() functions return a MMIOT* on success, and null on failure.

⭐ SEE ALSO ⭐

http://daringfireball.net/projects/markdown/syntax

💀 BUGS 💀

error handling is minimal at best. like, minimal minimal. she's trying her best okay 😭

the MMIOT created by mkd_string() is deleted by the markdown function. noted. don't touch it after, bestie. 🙈

and that's the whole page, you ate it, no crumbs 🍓✨ this little manual came from Mastodon, dated December 20, 2007 — yeah, she's vintage, she's a classic, and she's still serving. MARKDOWN(3) out. 💜🧚

📦 where this page comes from