MarkdownRenderer

java.lang.Object
- org.commonmark.renderer.markdown.MarkdownRenderer

All Implemented Interfaces:

Renderer
```
public class MarkdownRenderer
extends java.lang.Object
implements Renderer
```
Renders nodes to Markdown (CommonMark syntax); use builder() to create a renderer.
Note that it doesn't currently preserve the exact syntax of the original input Markdown (if any):
- Headings are output as ATX headings if possible (multi-line headings need Setext headings)
- Links are always rendered as inline links (no support for reference links yet)
- Escaping might be over-eager, e.g. a plain * might be escaped even though it doesn't need to be in that particular context
- Leading whitespace in paragraphs is not preserved
However, it should produce Markdown that is semantically equivalent to the input, i.e. if the Markdown was parsed again and compared against the original AST, it should be the same (minus bugs).

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MarkdownRenderer.Builder`	Builder for configuring a `MarkdownRenderer`.
`static interface`	`MarkdownRenderer.MarkdownRendererExtension`	Extension for `MarkdownRenderer` for rendering custom nodes.
`private class`	`MarkdownRenderer.RendererContext`

Field Summary

Fields
Modifier and Type Field Description

private java.util.List<MarkdownNodeRendererFactory> nodeRendererFactories

Constructor Summary

Constructors
Modifier Constructor Description

private MarkdownRenderer(MarkdownRenderer.Builder builder)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MarkdownRenderer.Builder`	`builder()`	Create a new builder for configuring a `MarkdownRenderer`.
`java.lang.String`	`render(Node node)`	Render the tree of nodes to string.
`void`	`render(Node node, java.lang.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

- Field Detail
  - nodeRendererFactories
```
private final java.util.List<MarkdownNodeRendererFactory> nodeRendererFactories
```
- Constructor Detail
  - MarkdownRenderer
```
private MarkdownRenderer(MarkdownRenderer.Builder builder)
```
- Method Detail
  - builder
```
public static MarkdownRenderer.Builder builder()
```
    Create a new builder for configuring a MarkdownRenderer.
    
    Returns:
    
    a builder
  - render
```
public void render(Node node,
                   java.lang.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 java.lang.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