Package org.commonmark.renderer.html
Class HtmlRenderer
java.lang.Object
org.commonmark.renderer.html.HtmlRenderer
- All Implemented Interfaces:
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 ClassesModifier and TypeClassDescriptionstatic class
Builder for configuring anHtmlRenderer
.static interface
Extension forHtmlRenderer
.private class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final List
<AttributeProviderFactory> private final boolean
private final List
<HtmlNodeRendererFactory> private final boolean
private final boolean
private final String
private final UrlSanitizer
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic HtmlRenderer.Builder
builder()
Create a new builder for configuring anHtmlRenderer
.Render the tree of nodes to string.void
render
(Node node, Appendable output) Render the tree of nodes to output.
-
Field Details
-
softbreak
-
escapeHtml
private final boolean escapeHtml -
sanitizeUrls
private final boolean sanitizeUrls -
urlSanitizer
-
percentEncodeUrls
private final boolean percentEncodeUrls -
attributeProviderFactories
-
nodeRendererFactories
-
-
Constructor Details
-
HtmlRenderer
-
-
Method Details
-
builder
Create a new builder for configuring anHtmlRenderer
.- Returns:
- a builder
-
render
Description copied from interface:Renderer
Render the tree of nodes to output. -
render
Description copied from interface:Renderer
Render the tree of nodes to string.
-