LOWDOWN_NROFF_RNDR(3)

NAME
lowdown_nroff_rndr - render Markdown into roff

LIBRARY
liblowdown

SYNOPSIS
#include <sys/queue.h>
#include <stdio.h>
#include <lowdown.h>
void
lowdown_nroff_rndr(struct lowdown_buf *out, struct lowdown_metaq *mq, void *arg, struct lowdown_node *n);

DESCRIPTION
Renders a node tree n created by lowdown_doc_parse(3) or lowdown_doc_diff(3) using the roff renderer arg as returned by lowdown_nroff_new(3). The output is written into out, which must be initialised and freed by the caller.

If mq is not NULL, it is filled with any metadata as parsed. It must be initialised and its contents freed with lowdown_metaq_free(3).

The output consists of roff output using the ms or man macro packages.

EXAMPLES
The following assumes the the string buf of length bsz consists of Markdown content.

    struct lowdown_buf *out;
    struct lowdown_doc *doc;
    void *rndr;
    struct lowdown_node *n;
    if ((doc = lowdown_doc_new(NULL)) == NULL)
    	err(1, NULL);
    if ((n = lowdown_doc_parse(doc, NULL, buf, bsz)) == NULL)
    	err(1, NULL);
    lowdown_doc_free(doc);
    if ((out = lowdown_buf_new(256)) == NULL)
    	err(1, NULL);
    if ((rndr = lowdown_nroff_new(NULL)) == NULL)
    	err(1, NULL);
    lowdown_nroff_rndr(out, NULL, rndr, n);
    lowdown_nroff_free(rndr);
    lowdown_node_free(n);
    fwrite(out->data, 1, out->size, stdout);
    lowdown_buf_free(out);

CAVEATS
The contents of n may be changed, but not in a way that will change the output with multiple passes at rendering.

SEE ALSO
lowdown(3), lowdown_nroff_free(3), lowdown_nroff_new(3)