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 and Inner Type Summary

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

Access	Constructor and Description
private	MarkdownRenderer(MarkdownRenderer.Builder builder)

Method Summary

Modifier and Type	Method and Description
public static MarkdownRenderer.Builder	Returns: a builder builder() Create a new builder for configuring a `MarkdownRenderer`.
public void	render(Node node, Appendable output) Implements jdk.internal.org.commonmark.renderer.Renderer.render. Render the tree of nodes to output.
public String	render(Node node) Implements jdk.internal.org.commonmark.renderer.Renderer.render. Render the tree of nodes to string.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

nodeRendererFactories	back to summary
private final List<MarkdownNodeRendererFactory> nodeRendererFactories

MarkdownRenderer	back to summary
private MarkdownRenderer(MarkdownRenderer.Builder builder)

Method Detail

builder back to summary

builder	back to summary
public static MarkdownRenderer.Builder builder() Create a new builder for configuring a `MarkdownRenderer`. Returns:MarkdownRenderer.Builder a builder

public static MarkdownRenderer.Builder builder()

Create a new builder for configuring a MarkdownRenderer.

Returns:MarkdownRenderer.Builder: a builder

render	back to summary
public void render(Node node, Appendable output) Implements jdk.internal.org.commonmark.renderer.Renderer.render. Doc from jdk.internal.org.commonmark.renderer.Renderer.render. Render the tree of nodes to output. Annotations @Override

render

back to summary

public void render(Node node, Appendable output)

Implements jdk.internal.org.commonmark.renderer.Renderer.render.

Doc from jdk.internal.org.commonmark.renderer.Renderer.render.

Render the tree of nodes to output.

Annotations

@Override

render	back to summary
public String render(Node node) Implements jdk.internal.org.commonmark.renderer.Renderer.render. Doc from jdk.internal.org.commonmark.renderer.Renderer.render. Render the tree of nodes to string. Annotations @Override

render

back to summary

public String render(Node node)

Implements jdk.internal.org.commonmark.renderer.Renderer.render.

Doc from jdk.internal.org.commonmark.renderer.Renderer.render.

Render the tree of nodes to string.

Annotations

@Override

jdk.internal.org.commonmark.renderer.markdown back to summary

public Class MarkdownRenderer.Builder

Class Inheritance

extends Object

java.lang.Object
jdk.internal.org.commonmark.renderer.markdown.MarkdownRenderer.Builder

Builder for configuring a MarkdownRenderer. See methods for default configuration.

Field Summary

Modifier and Type	Field and Description
private final List<MarkdownNodeRendererFactory>	nodeRendererFactories

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public MarkdownRenderer	build() Returns: the configured `MarkdownRenderer`
public MarkdownRenderer.Builder	extensions(Iterable<? extends Extension> extensions to use on this renderer extensions) Returns: `this`
public MarkdownRenderer.Builder	Returns: `this` nodeRendererFactory(MarkdownNodeRendererFactory the factory for creating a node renderer nodeRendererFactory) Add a factory for instantiating a node renderer (done when rendering).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

nodeRendererFactories	back to summary
private final List<MarkdownNodeRendererFactory> nodeRendererFactories

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build	back to summary
public MarkdownRenderer build() Returns:MarkdownRenderer the configured `MarkdownRenderer`

extensions	back to summary
public MarkdownRenderer.Builder extensions(Iterable<? extends Extension> extensions) Parameters extensions:Iterable<? extends Extension> extensions to use on this renderer Returns:MarkdownRenderer.Builder `this`

nodeRendererFactory back to summary

nodeRendererFactory	back to summary
public MarkdownRenderer.Builder nodeRendererFactory(MarkdownNodeRendererFactory nodeRendererFactory) Add a factory for instantiating a node renderer (done when rendering). This allows to override the rendering of node types or define rendering for custom node types. If multiple node renderers for the same node type are created, the one from the factory that was added first "wins". (This is how the rendering for core node types can be overridden; the default rendering comes last.) Parameters nodeRendererFactory:MarkdownNodeRendererFactory the factory for creating a node renderer Returns:MarkdownRenderer.Builder `this`

public MarkdownRenderer.Builder nodeRendererFactory(MarkdownNodeRendererFactory nodeRendererFactory)

Add a factory for instantiating a node renderer (done when rendering). This allows to override the rendering of node types or define rendering for custom node types.

If multiple node renderers for the same node type are created, the one from the factory that was added first "wins". (This is how the rendering for core node types can be overridden; the default rendering comes last.)

Parameters

nodeRendererFactory:MarkdownNodeRendererFactory: the factory for creating a node renderer

Returns:MarkdownRenderer.Builder

this

jdk.internal.org.commonmark.renderer.markdown back to summary

public Interface MarkdownRenderer.MarkdownRendererExtension

Known Direct Implementers: jdk.internal.org.commonmark.ext.gfm.tables.TablesExtension

Extension for MarkdownRenderer for rendering custom nodes.

Method Summary

Modifier and Type	Method and Description
public void	extend(MarkdownRenderer.Builder the renderer builder to extend rendererBuilder) Extend Markdown rendering, usually by registering custom node renderers using `Builder#nodeRendererFactory`.

Method Detail

extend back to summary

extend	back to summary
public void extend(MarkdownRenderer.Builder rendererBuilder) Extend Markdown rendering, usually by registering custom node renderers using `Builder#nodeRendererFactory`. Parameters rendererBuilder:MarkdownRenderer.Builder the renderer builder to extend

public void extend(MarkdownRenderer.Builder rendererBuilder)

Extend Markdown rendering, usually by registering custom node renderers using Builder#nodeRendererFactory.

Parameters

rendererBuilder:MarkdownRenderer.Builder: the renderer builder to extend

jdk.internal.org.commonmark.renderer.markdown back to summary

private Class MarkdownRenderer.RendererContext

Class Inheritance

extends Object
implements MarkdownNodeRendererContext

java.lang.Object
jdk.internal.org.commonmark.renderer.markdown.MarkdownRenderer.RendererContext

All Implemented Interfaces

jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext

Field Summary

Modifier and Type	Field and Description
private final Set<Character>	additionalTextEscapes
private final NodeRendererMap	nodeRendererMap
private final MarkdownWriter	writer

Constructor Summary

Access	Constructor and Description
private	RendererContext(MarkdownWriter writer)

Method Summary

Modifier and Type	Method and Description
public Set<Character>	getSpecialCharacters() Implements jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.getSpecialCharacters.
public MarkdownWriter	getWriter() Implements jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.getWriter.
public void	render(Node node) Implements jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.render. Render the specified node and its children using the configured renderers.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

additionalTextEscapes	back to summary
private final Set<Character> additionalTextEscapes

nodeRendererMap	back to summary
private final NodeRendererMap nodeRendererMap

writer	back to summary
private final MarkdownWriter writer

Constructor Detail

RendererContext	back to summary
private RendererContext(MarkdownWriter writer)

Method Detail

getSpecialCharacters	back to summary
public Set<Character> getSpecialCharacters() Implements jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.getSpecialCharacters. Annotations @Override

getSpecialCharacters

back to summary

public Set<Character> getSpecialCharacters()

Implements jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.getSpecialCharacters.

Annotations

@Override

getWriter	back to summary
public MarkdownWriter getWriter() Implements jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.getWriter. Annotations @Override

getWriter

back to summary

public MarkdownWriter getWriter()

Implements jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.getWriter.

Annotations

@Override

render	back to summary
public void render(Node node) Implements jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.render. Doc from jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.render. Render the specified node and its children using the configured renderers. This should be used to render child nodes; be careful not to pass the node that is being rendered, that would result in an endless loop. Annotations @Override

render

back to summary

public void render(Node node)

Implements jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.render.

Doc from jdk.internal.org.commonmark.renderer.markdown.MarkdownNodeRendererContext.render.

Render the specified node and its children using the configured renderers. This should be used to render child nodes; be careful not to pass the node that is being rendered, that would result in an endless loop.

Annotations

@Override