lowdown_html_new(3)

lowdown_html_new3

Allocate a markdown html renderer

Usage

#include <sys/queue.h>

#include <stdio.h>

#include <lowdown.h>

void *

lowdown_html_new(const struct lowdown_opts *opts);

Library

library “liblowdown”

Overview

Allocates an HTML5 renderer using opts->flags, or zero if opts is NULL. This field is documented in lowdown(3). The returned pointer may be used with multiple invocations of lowdown_html_rndr(3) and must be freed with lowdown_html_free(3).

The bits recognised in opts->oflags are LOWDOWN_HTML_HTML_CUSTOM_ATTRS, LOWDOWN_HTML_OWASP, LOWDOWN_HTML_NUM_ENT, LOWDOWN_HTML_HEAD_IDS, LOWDOWN_HTML_HARD_WRAP, LOWDOWN_SKIP_HTML, LOWDOWN_HTML_ESCAPE, LOWDOWN_HTML_CALLOUT_MDN, LOWDOWN_HTML_CALLOUT_GFM, and LOWDOWN_STANDALONE.

Return values

Returns a pointer to the renderer or NULL on memory failure. The returned pointer must be freed with lowdown_html_free(3).

Examples

The following parses b of length bsz and outputs in HTML format.

struct lowdown_buf *out;
struct lowdown_doc *doc;
struct lowdown_node *n;
void *rndr;
if ((doc = lowdown_doc_new(NULL)) == NULL)
	err(1, NULL);
if ((n = lowdown_doc_parse(doc, NULL, b, bsz, NULL)) == NULL)
	err(1, NULL);
if ((out = lowdown_buf_new(256)) == NULL)
	err(1, NULL);
if ((rndr = lowdown_html_new(NULL)) == NULL)
	err(1, NULL);
if (!lowdown_html_rndr(out, rndr, n))
	err(1, NULL);
fwrite(out->data, 1, out->size, stdout);
lowdown_html_free(rndr);
lowdown_buf_free(out);
lowdown_node_free(n);
lowdown_doc_free(doc);

Releases

4 releases since Debian 11 (Bullseye); the text changed 3 times.

  1. 11
  2. 12
  3. 13
  4. Arch

Standards

The referenced HTML5 standard is HTML5.2: https://www.w3.org/TR/html52. Output is compatible with prior HTML5 standards.

From lowdown 3.2.1-1 in Arch Linux 2026-11-01. Parsed by carta from the page's mdoc source.