Man page - lowdown_gemini_rndr(3)

Packages contains this manual

Manual


LOWDOWN_GEMINI_RNDR (3) Library Functions Manual LOWDOWN_GEMINI_RNDR (3)

NAME

lowdown_gemini_rndr — render Markdown into gemini

LIBRARY

library “liblowdown”

SYNOPSIS

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

int

lowdown_gemini_rndr ( struct lowdown_buf *out , void *arg , const struct lowdown_node *n );

DESCRIPTION

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

The caller is expected to have invoked setlocale (3) to a "UTF-8" character encoding prior to using this function, otherwise UTF-8 sequences will not be properly recognised. This is used when formatting table column widths.

RETURN VALUES

Returns zero on failure to allocate memory, non-zero on success.

EXAMPLES

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

struct lowdown_buf *out;
struct lowdown_doc *doc;
struct lowdown_node *n;
void *rndr;

if (setlocale(LC_CTYPE, "en_US.UTF-8") == NULL)

err(1, NULL);

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_gemini_new(NULL)) == NULL)

err(1, NULL);

if (!lowdown_gemini_rndr(out, rndr, n))

err(1, NULL);

fwrite(out->data, 1, out->size, stdout);

lowdown_gemini_free(rndr);
lowdown_buf_free(out);
lowdown_node_free(n);
lowdown_doc_free(doc);

SEE ALSO

lowdown (3), lowdown_gemini_free (3), lowdown_gemini_new (3)

STANDARDS

The gemini “gemtext” format is documented in Project Gemini : https://geminiprotocol.net. The version at the time of writing is 0.24.1. Debian $Mdocdate$ LOWDOWN_GEMINI_RNDR (3)