Package org.commonmark.renderer.markdown
Class MarkdownRenderer
java.lang.Object
org.commonmark.renderer.markdown.MarkdownRenderer
- All Implemented Interfaces:
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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Builder for configuring aMarkdownRenderer
.static interface
Extension forMarkdownRenderer
for rendering custom nodes.private class
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic MarkdownRenderer.Builder
builder()
Create a new builder for configuring aMarkdownRenderer
.Render the tree of nodes to string.void
render
(Node node, Appendable output) Render the tree of nodes to output.
-
Field Details
-
nodeRendererFactories
-
-
Constructor Details
-
MarkdownRenderer
-
-
Method Details
-
builder
Create a new builder for configuring aMarkdownRenderer
.- 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.
-