LOWDOWN_BUF(3)

💖 LOWDOWN_BUF(3) 💖

okay bestie, so this is a page from the Library Functions Manual — it's the liblowdown girlies' territory, and today we're talking about lowdown_buf. buckle up 🎀

---

✨ NAME ✨

lowdown_buf — parse a Markdown buffer into formatted output

---

📚 LIBRARY 📚

library “liblowdown” 🫶

---

🌸 SYNOPSIS 🌸

#include <sys/queue.h>
#include <stdio.h>
#include <lowdown.h>

int
lowdown_buf(const struct lowdown_opts *opts, const char *buf,
    size_t bufsz, char **ret, size_t *retsz,
    struct lowdown_metaq *metaq);

---

💅 DESCRIPTION 💅

so basically 💫 it parses a lowdown(5) buffer buf of size bufsz into an output buffer ret of size retsz, all according to a configuration opts. the output format? that's whatever opts->type says it is, no cap.

if LOWDOWN_METADATA is set in opts->feat and metaq is not NULL, then metaq gets filled with metadata rendered in the given output format. slay ✨

🚨 important bestie: the caller is responsible for freeing ret and metaq. that's on you, not on us. don't forget, fr fr 😭

---

🔥 RETURN VALUES 🔥

returns zero on failure, non-zero on success. periodt.

💀 on failure, the values pointed to by res and rsz are undefined. (yes, we know the params are called ret and retsz — the page literally says res and rsz, and we do not gatekeep, we report. 🙈)

---

🦋 EXAMPLES 🦋

the following parses standard input into a standalone HTML5 document. it enables footnotes, autolinks, tables, superscript, strikethrough, fenced codeblocks, commonmark, definition lists, extended image attributes, and metadata processing. the output passes through raw HTML and has smart typography. iconic honestly 👑

struct lowdown_opts opts;
char *buf = NULL, *obuf;
char rbuf[1024];
size_t sz, bufsz = 0, obufsz;

while (!(feof(stdin) || ferror(stdin))) {
        sz = fread(rbuf, 1, sizeof(rbuf), stdin);
        if (sz == 0)
                err(1, "fread");
        buf = realloc(buf, bufsz + sz);
        if (buf == NULL)
                err(1, NULL);
        memcpy(buf + bufsz, rbuf, sz);
        bufsz += sz;
}

if (ferror(stdin))
        err(1, "fread");

memset(&opts, 0, sizeof(struct lowdown_opts));
opts.type = LOWDOWN_HTML;
opts.feat = LOWDOWN_FOOTNOTES |
        LOWDOWN_AUTOLINK |
        LOWDOWN_TABLES |
        LOWDOWN_SUPER |
        LOWDOWN_STRIKE |
        LOWDOWN_FENCED |
        LOWDOWN_COMMONMARK |
        LOWDOWN_DEFLIST |
        LOWDOWN_IMG_EXT |
        LOWDOWN_METADATA;
opts.oflags = LOWDOWN_HTML_HEAD_IDS |
        LOWDOWN_HTML_NUM_ENT |
        LOWDOWN_HTML_OWASP |
        LOWDOWN_SMARTY |
        LOWDOWN_STANDALONE;
if (!lowdown_buf(&opts, buf, bufsz, &obuf, &obufsz, NULL))
        errx(1, "lowdown_buf");
fwrite(buf, 1, bufsz, stdout);
free(buf);
free(obuf);

---

🌈 SEE ALSO 🌈

• lowdown(3)
• lowdown_metaq_free(3)

---

and that's the whole vibe, bestie 💖 this Debian page was served up on $Mdocdate$ under the name LOWDOWN_BUF(3) — go forth and parse, you main character 🌟