Package 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);

  • Field Details

    • softbreak

      private final String softbreak

    • escapeHtml

      private final boolean escapeHtml

    • percentEncodeUrls

      private final boolean percentEncodeUrls

    • omitSingleParagraphP

      private final boolean omitSingleParagraphP

    • sanitizeUrls

      private final boolean sanitizeUrls

    • urlSanitizer

      private final UrlSanitizer urlSanitizer

    • attributeProviderFactories

      private final List<AttributeProviderFactory> attributeProviderFactories

    • nodeRendererFactories

      private final List<HtmlNodeRendererFactory> nodeRendererFactories

  • Constructor Details

  • Method Details

    • 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