4 Rendering Output🔗

A Punct document is format-independent; when you want to use it in an output file, it must be rendered into that output file’s format.

Punct currently includes an HTML renderer and a plain-text renderer. Both are based on a “base” renderer. You can extend any Punct renderer or the base renderer to customize the process of converting documents to your target output format(s).

4.1 Rendering HTML🔗

This function uses xexpr->string to generate the HTML string. This function will blindly escape characters inside <script> and <style> tags, which may introduce errors. For HTML output that is friendlier and more correct, consider using the html-printer package in concert with doc->html-xexpr.

For more information on using the fallback argument to render custom elements, see Rendering custom elements.

For more information on using the fallback argument to render custom elements, see Rendering custom elements.

4.2 Rendering plain text🔗

Sometimes you want to convert a document into a text format that is even plainer than Markdown, such as when generating the plaintext version of an email newsletter.

The function applies very rudimentary text formatting which usually looks as you would expect, but which often discards information.

• Level 1 headings are underlined with =, and all other headings are underlined with -.

• Link destination URLs are given inside parentheses directly following the link text.

• Code blocks are indented with four spaces, and the language name, if any, is discarded.

• Images are replaced with their “alt” text, prefixed by "Image: " and wrapped in parentheses; the source URL and title are discarded.

For more information on using the fallback argument to render custom elements, see Rendering custom elements.