| Package | Description |
|---|---|
| org.commonmark.node |
AST node types (see
Node) and visitors (see AbstractVisitor) |
| org.commonmark.parser |
Parsing input text to AST nodes (see
Parser) |
| org.commonmark.renderer | |
| org.commonmark.renderer.html |
HTML rendering (see
HtmlRenderer) |
| org.commonmark.renderer.text |
Text content rendering (see
TextContentRenderer) |
| Modifier and Type | Class and Description |
|---|---|
class |
Block
Block nodes such as paragraphs, list blocks, code blocks etc.
|
class |
BlockQuote |
class |
BulletList |
class |
Code |
class |
CustomBlock |
class |
CustomNode |
class |
Document |
class |
Emphasis |
class |
FencedCodeBlock |
class |
HardLineBreak |
class |
Heading |
class |
HtmlBlock
HTML block
|
class |
HtmlInline
Inline HTML element.
|
class |
Image |
class |
IndentedCodeBlock |
class |
Link
A link with a destination and an optional title; the link text is in child nodes.
|
class |
LinkReferenceDefinition
A link reference definition, e.g.:
|
class |
ListBlock |
class |
ListItem |
class |
OrderedList |
class |
Paragraph
A paragraph block, contains inline nodes such as
Text |
class |
SoftLineBreak |
class |
StrongEmphasis |
class |
Text |
class |
ThematicBreak |
| Modifier and Type | Method and Description |
|---|---|
Node |
Node.getFirstChild() |
Node |
Node.getLastChild() |
Node |
Node.getNext() |
Node |
Node.getParent() |
Node |
Node.getPrevious() |
| Modifier and Type | Method and Description |
|---|---|
static Iterable<Node> |
Nodes.between(Node start,
Node end)
The nodes between (not including) start and end.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Node.appendChild(Node child) |
static Iterable<Node> |
Nodes.between(Node start,
Node end)
The nodes between (not including) start and end.
|
void |
Node.insertAfter(Node sibling) |
void |
Node.insertBefore(Node sibling) |
void |
Node.prependChild(Node child) |
protected void |
Block.setParent(Node parent) |
protected void |
Node.setParent(Node parent) |
protected void |
AbstractVisitor.visitChildren(Node parent)
Visit the child nodes.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SourceSpans.addAllFrom(Iterable<? extends Node> nodes) |
| Modifier and Type | Method and Description |
|---|---|
Node |
Parser.parse(String input)
Parse the specified input text into a tree of nodes.
|
Node |
Parser.parseReader(Reader input)
Parse the specified reader into a tree of nodes.
|
Node |
PostProcessor.process(Node node) |
| Modifier and Type | Method and Description |
|---|---|
void |
InlineParser.parse(SourceLines lines,
Node node) |
Node |
PostProcessor.process(Node node) |
| Modifier and Type | Method and Description |
|---|---|
Set<Class<? extends Node>> |
NodeRenderer.getNodeTypes() |
| Modifier and Type | Method and Description |
|---|---|
String |
Renderer.render(Node node)
Render the tree of nodes to string.
|
void |
NodeRenderer.render(Node node)
Render the specified node.
|
void |
Renderer.render(Node node,
Appendable output)
Render the tree of nodes to output.
|
| Modifier and Type | Method and Description |
|---|---|
Set<Class<? extends Node>> |
CoreHtmlNodeRenderer.getNodeTypes() |
| Modifier and Type | Method and Description |
|---|---|
Map<String,String> |
HtmlNodeRendererContext.extendAttributes(Node node,
String tagName,
Map<String,String> attributes)
Let extensions modify the HTML tag attributes.
|
void |
CoreHtmlNodeRenderer.render(Node node) |
void |
HtmlNodeRendererContext.render(Node node)
Render the specified node and its children using the configured renderers.
|
String |
HtmlRenderer.render(Node node) |
void |
HtmlRenderer.render(Node node,
Appendable output) |
void |
AttributeProvider.setAttributes(Node node,
String tagName,
Map<String,String> attributes)
Set the attributes for a HTML tag of the specified node by modifying the provided map.
|
protected void |
CoreHtmlNodeRenderer.visitChildren(Node parent) |
| Modifier and Type | Method and Description |
|---|---|
Set<Class<? extends Node>> |
CoreTextContentNodeRenderer.getNodeTypes() |
| Modifier and Type | Method and Description |
|---|---|
void |
TextContentNodeRendererContext.render(Node node)
Render the specified node and its children using the configured renderers.
|
String |
TextContentRenderer.render(Node node) |
void |
CoreTextContentNodeRenderer.render(Node node) |
void |
TextContentRenderer.render(Node node,
Appendable output) |
protected void |
CoreTextContentNodeRenderer.visitChildren(Node parent) |
Copyright © 2021. All rights reserved.