org.commonmark.renderer.html

Class HtmlRenderer

java.lang.Object

org.commonmark.renderer.html.HtmlRenderer

All Implemented Interfaces:

Renderer

public class HtmlRenderer
extends Object
implements Renderer

Renders a tree of nodes to HTML.

Start with the builder() method to configure the renderer. Example:

 HtmlRenderer renderer = HtmlRenderer.builder().escapeHtml(true).build();
 renderer.render(node);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HtmlRenderer.Builder Builder for configuring an HtmlRenderer.
static interface	HtmlRenderer.HtmlRendererExtension Extension for HtmlRenderer.

Method Summary

Modifier and Type	Method and Description
static HtmlRenderer.Builder	builder() Create a new builder for configuring an HtmlRenderer.
String	render(Node node) Render the tree of nodes to string.
void	render(Node node, Appendable output) Render the tree of nodes to output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static HtmlRenderer.Builder builder()

Create a new builder for configuring an HtmlRenderer.

Returns:

a builder

render

public void render(Node node,
                   Appendable output)

Description copied from interface: Renderer

Render the tree of nodes to output.

Specified by:

render in interface Renderer

Parameters:

node - the root node

output - output for rendering

render

public String render(Node node)

Description copied from interface: Renderer

Render the tree of nodes to string.

Specified by:

render in interface Renderer

Parameters:

node - the root node

Returns:

the rendered string