All Classes and Interfaces
Class
Description
Abstract visitor that visits all children by default.
Alert block for highlighting important information using
[!TYPE] syntax.Extension for GFM alerts using
[!TYPE] syntax (GitHub Flavored Markdown).Builder for configuring the alerts extension.
Inline content container for the optional custom title of an
Alert.Char matcher that can match ASCII characters efficiently.
Extension point for adding/changing attributes on HTML tags for a node.
The context for attribute providers.
Factory for instantiating new attribute providers when rendering is done.
Extension for automatically turning plain URLs and email addresses into links.
Attempt to parse an autolink (URL or email in pointy brackets).
The types of strings that can be automatically turned into links.
Parse a backslash-escaped special character, adding either the escaped character, a hard line
break (if the backslash is followed by a newline), or a literal backslash to the block's
children.
Attempt to parse backticks, returning either a backtick code span or a literal sequence of
backticks.
Block nodes such as paragraphs, list blocks, code blocks etc.
Result object for continuing parsing of a block, see static methods for constructors.
Parser for a specific block node.
Parser factory for a block node for determining when a block starts.
A block quote, e.g.:
Result object for starting parsing of a block, see static methods for constructors.
Opening bracket for links (
[), images (![), or links with other markers.A bullet list, e.g.:
Functions for finding characters in strings or checking characters.
Matcher interface for
char values.Inline code span, e.g.:
The node renderer that renders all the core nodes (comes last in the order of node renderers).
The node renderer that renders all the core nodes (comes last in the order of node renderers).
Visits nodes to check if there are any soft or hard line breaks.
The node renderer that renders all the core nodes (comes last in the order of node renderers).
A block that extensions can subclass to define custom blocks (not part of the core
specification).
A node that extensions can subclass to define custom nodes (not part of the core specification).
Allows http, https, mailto, and data protocols for url.
A map that can be used to store and look up reference definitions by a label.
A node that uses delimiters in the source form (e.g.
Delimiter (emphasis, strong emphasis or custom emphasis).
Custom delimiter processor for additional delimiters besides
_ and *.A delimiter run is one or more of the same delimiter character, e.g.
The root block of a document, containing the top-level blocks.
Emphasis, e.g.:
Attempts to parse an HTML entity or numeric character reference.
Reader for files containing examples of CommonMark source and the expected HTML rendering (e.g.
Base interface for a parser/renderer extension.
A fenced code block, e.g.:
Parser for a single
FootnoteDefinition block.A footnote definition, e.g.:
HTML rendering for footnotes.
Visit footnote references/inline footnotes inside the parent (but not the parent itself).
For turning e.g.
A footnote reference, e.g.
Extension for footnotes with syntax like GitHub Flavored Markdown:
Parses the content of the front matter block between `---` separators.
A hard line break, e.g.:
A heading, e.g.:
Extension for adding auto generated IDs to headings.
HTML block
Inline HTML element.
Attempt to parse inline HTML.
Factory for instantiating new node renderers when rendering is done.
Renders a tree of nodes to HTML.
Builder for configuring an
HtmlRenderer.Extension for
HtmlRenderer.Generates strings to be used as identifiers.
An image, e.g.:
A node containing text and other inline nodes as children.
Extension for adding attributes to image nodes.
Whether to include
SourceSpan or not while parsing, see Parser.Builder.includeSourceSpans(IncludeSourceSpans).An indented code block, e.g.:
Parser for a type of inline content.
A factory for extending inline content parsing.
Parser for inline content (text, links, emphasized text, etc).
Context for inline parsing.
Factory for custom inline parser.
A destination and optional title for a link or image.
An ins node containing text and other inline nodes as children.
Extension for ins using ++
Control how line breaks are rendered.
Reads lines from a reader like
BufferedReader but also returns the line
terminators.A link with a destination and an optional title; the link text is in child nodes.
A parsed link/image.
An interface to decide how links/images are handled.
A link reference definition, e.g.:
Parser for link reference definitions at the beginning of a paragraph.
What to do with a link/image processed by
LinkProcessor.A list block like
BulletList or OrderedList.A child of a
ListBlock, containing other blocks (e.g.Context that is passed to custom node renderers, see
MarkdownNodeRendererFactory.create(org.commonmark.renderer.markdown.MarkdownNodeRendererContext).Factory for instantiating new node renderers for rendering custom nodes.
Renders nodes to Markdown (CommonMark syntax); use
MarkdownRenderer.builder() to create a renderer.Builder for configuring a
MarkdownRenderer.Extension for
MarkdownRenderer for rendering custom nodes.Writer for Markdown (CommonMark) text.
Open block parser that was last matched during the continue phase.
The base class of all CommonMark AST nodes (
Block and inlines).A renderer for a set of node types.
Utility class for working with multiple
Nodes.An ordered list, e.g.:
A paragraph block, contains inline nodes such as
TextThe result of a single inline parser.
Parses input text to a tree of nodes.
Builder for configuring a
Parser.Extension for
Parser.State of the parser that is used in block parsers.
Position within a
Scanner.A soft line break (as opposed to a
HardLineBreak), e.g.A line or part of a line from the input source.
A set of lines (
SourceLine) from the input source.A source span references a snippet of text from the source input.
A list of source spans that can be added to.
An implementation of DelimiterProcessor that dispatches all calls to two or more other
DelimiterProcessors depending on the length of the delimiter run.
A strikethrough node containing text and other inline nodes as children.
Extension for GFM strikethrough using
~ or ~~ (GitHub Flavored Markdown).Strong emphasis, e.g.:
Body part of a
TableBlock containing TableRows.Table cell of a
TableRow containing inline nodes.How the cell is aligned horizontally.
Head part of a
TableBlock containing TableRows.The Table node renderer that is needed for rendering GFM tables (GitHub Flavored Markdown) to
text content.
Extension for GFM tables using "|" pipes (GitHub Flavored Markdown).
The Table node renderer that is needed for rendering GFM tables (GitHub Flavored Markdown) to
text content.
A marker node indicating that a list item contains a task.
Extension for adding task list items.
A text node, e.g.
Factory for instantiating new node renderers when rendering is done.
Renders nodes to plain text content with minimal markup-like additions.
Builder for configuring a
TextContentRenderer.Extension for
TextContentRenderer.A thematic break, e.g.
Sanitizes urls for img and a elements by whitelisting protocols.
Node visitor.
Extension for YAML-like metadata.