All Classes

Class	Description
AbstractBlockParser
AbstractBlockParserFactory
AbstractVisitor	Abstract visitor that visits all children by default.
AsciiMatcher	Char matcher that can match ASCII characters efficiently.
AsciiMatcher.Builder
Asserts
AsteriskDelimiterProcessor
AttributeProvider	Extension point for adding/changing attributes on HTML tags for a node.
AttributeProviderContext	The context for attribute providers.
AttributeProviderFactory	Factory for instantiating new attribute providers when rendering is done.
AutolinkExtension	Extension for automatically turning plain URLs and email addresses into links.
AutolinkInlineParser	Attempt to parse an autolink (URL or email in pointy brackets).
AutolinkInlineParser.Factory
AutolinkPostProcessor
BackslashInlineParser	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.
BackslashInlineParser.Factory
BackticksInlineParser	Attempt to parse backticks, returning either a backtick code span or a literal sequence of backticks.
BackticksInlineParser.Factory
Block	Block nodes such as paragraphs, list blocks, code blocks etc.
BlockContent
BlockContinue	Result object for continuing parsing of a block, see static methods for constructors.
BlockContinueImpl
BlockParser	Parser for a specific block node.
BlockParserFactory	Parser factory for a block node for determining when a block starts.
BlockQuote
BlockQuoteParser
BlockQuoteParser.Factory
BlockStart	Result object for starting parsing of a block, see static methods for constructors.
BlockStartImpl
Bracket	Opening bracket for links ([), images (![), or links with other markers.
BulletList
BulletListHolder
Characters	Functions for finding characters in strings or checking characters.
CharMatcher	Matcher interface for char values.
Code
CoreHtmlNodeRenderer	The node renderer that renders all the core nodes (comes last in the order of node renderers).
CoreHtmlNodeRenderer.AltTextVisitor
CoreLinkProcessor
CoreMarkdownNodeRenderer	The node renderer that renders all the core nodes (comes last in the order of node renderers).
CoreMarkdownNodeRenderer.BulletListHolder
CoreMarkdownNodeRenderer.LineBreakVisitor	Visits nodes to check if there are any soft or hard line breaks.
CoreMarkdownNodeRenderer.ListHolder
CoreMarkdownNodeRenderer.OrderedListHolder
CoreTextContentNodeRenderer	The node renderer that renders all the core nodes (comes last in the order of node renderers).
CustomBlock
CustomNode
DefaultUrlSanitizer	Allows http, https, mailto, and data protocols for url.
DefinitionMap<D>	A map that can be used to store and look up reference definitions by a label.
Definitions
Delimited	A node that uses delimiters in the source form (e.g.
Delimiter	Delimiter (emphasis, strong emphasis or custom emphasis).
DelimiterProcessor	Custom delimiter processor for additional delimiters besides _ and *.
DelimiterRun	A delimiter run is one or more of the same delimiter character, e.g.
Document
DocumentBlockParser
DocumentParser
DocumentParser.MatchedBlockParserImpl
DocumentParser.OpenBlockParser
Emphasis
EmphasisDelimiterProcessor
EntityInlineParser	Attempts to parse an HTML entity or numeric character reference.
EntityInlineParser.Factory
Escaping
Escaping.Replacer
Example
ExampleReader	Reader for files containing examples of CommonMark source and the expected HTML rendering (e.g.
ExampleReader.State
Extension	Base interface for a parser/renderer extension.
FencedCodeBlock
FencedCodeBlockParser
FencedCodeBlockParser.Factory
FootnoteBlockParser	Parser for a single FootnoteDefinition block.
FootnoteBlockParser.Factory
FootnoteDefinition	A footnote definition, e.g.:
FootnoteHtmlNodeRenderer	HTML rendering for footnotes.
FootnoteHtmlNodeRenderer.DefinitionVisitor
FootnoteHtmlNodeRenderer.ReferencedDefinition
FootnoteHtmlNodeRenderer.ReferenceInfo
FootnoteHtmlNodeRenderer.ShallowReferenceVisitor	Visit footnote references/inline footnotes inside the parent (but not the parent itself).
FootnoteLinkProcessor	For turning e.g.
FootnoteMarkdownNodeRenderer
FootnoteReference	A footnote reference, e.g.
FootnotesExtension	Extension for footnotes with syntax like GitHub Flavored Markdown:
FootnotesExtension.Builder
HardLineBreak
Heading
HeadingAnchorExtension	Extension for adding auto generated IDs to headings.
HeadingAnchorExtension.Builder
HeadingIdAttributeProvider
HeadingParser
HeadingParser.Factory
Html5Entities
HtmlBlock	HTML block
HtmlBlockParser
HtmlBlockParser.Factory
HtmlInline	Inline HTML element.
HtmlInlineParser	Attempt to parse inline HTML.
HtmlInlineParser.Factory
HtmlNodeRendererContext
HtmlNodeRendererFactory	Factory for instantiating new node renderers when rendering is done.
HtmlRenderer	Renders a tree of nodes to HTML.
HtmlRenderer.Builder	Builder for configuring an HtmlRenderer.
HtmlRenderer.HtmlRendererExtension	Extension for HtmlRenderer.
HtmlWriter
IdGenerator	Generates strings to be used as identifiers.
IdGenerator.Builder
Image
ImageAttributes	A node containing text and other inline nodes as children.
ImageAttributesAttributeProvider
ImageAttributesDelimiterProcessor
ImageAttributesExtension	Extension for adding attributes to image nodes.
IncludeSourceSpans	Whether to include SourceSpan or not while parsing, see Parser.Builder.includeSourceSpans(IncludeSourceSpans).
IndentedCodeBlock
IndentedCodeBlockParser
IndentedCodeBlockParser.Factory
InlineContentParser	Parser for a type of inline content.
InlineContentParserFactory	A factory for extending inline content parsing.
InlineFootnote
InlineParser	Parser for inline content (text, links, emphasized text, etc).
InlineParserContext	Context for inline parsing.
InlineParserContextImpl
InlineParserFactory	Factory for custom inline parser.
InlineParserImpl
InlineParserImpl.DelimiterData
InlineParserImpl.DestinationTitle	A destination and optional title for a link or image.
InlineParserImpl.LinkInfoImpl
InlineParserState
Ins	An ins node containing text and other inline nodes as children.
InsDelimiterProcessor
InsExtension	Extension for ins using ++
InsHtmlNodeRenderer
InsMarkdownNodeRenderer
InsNodeRenderer
InsTextContentNodeRenderer
IntegrationTests	Module with integration tests.
LineBreakRendering	Control how line breaks are rendered.
LineReader	Reads lines from a reader like BufferedReader but also returns the line terminators.
Link	A link with a destination and an optional title; the link text is in child nodes.
LinkInfo	A parsed link/image.
LinkProcessor	An interface to decide how links/images are handled.
LinkReferenceDefinition	A link reference definition, e.g.:
LinkReferenceDefinitionParser	Parser for link reference definitions at the beginning of a paragraph.
LinkReferenceDefinitionParser.State
LinkResult	What to do with a link/image processed by LinkProcessor.
LinkResultImpl
LinkResultImpl.Type
LinkScanner
ListBlock
ListBlockParser
ListBlockParser.Factory
ListBlockParser.ListData
ListBlockParser.ListMarkerData
ListHolder
ListItem
ListItemParser
MarkdownNodeRendererContext	Context that is passed to custom node renderers, see MarkdownNodeRendererFactory.create(org.commonmark.renderer.markdown.MarkdownNodeRendererContext).
MarkdownNodeRendererFactory	Factory for instantiating new node renderers for rendering custom nodes.
MarkdownRenderer	Renders nodes to Markdown (CommonMark syntax); use MarkdownRenderer.builder() to create a renderer.
MarkdownRenderer.Builder	Builder for configuring a MarkdownRenderer.
MarkdownRenderer.MarkdownRendererExtension	Extension for MarkdownRenderer for rendering custom nodes.
MarkdownWriter	Writer for Markdown (CommonMark) text.
MatchedBlockParser	Open block parser that was last matched during the continue phase.
Node	The base class of all CommonMark AST nodes (Block and inlines).
NodeRenderer	A renderer for a set of node types.
NodeRendererMap
Nodes	Utility class for working with multiple Nodes.
Nodes.NodeIterable
Nodes.NodeIterator
OrderedList
OrderedListHolder
Paragraph	A paragraph block, contains inline nodes such as Text
ParagraphParser
ParsedInline	The result of a single inline parser.
ParsedInlineImpl
Parser	Parses input text to a tree of nodes.
Parser.Builder	Builder for configuring a Parser.
Parser.ParserExtension	Extension for Parser.
ParserState	State of the parser that is used in block parsers.
Parsing
Position	Position within a Scanner.
PostProcessor
Renderer
RenderingTestCase
Scanner
SoftLineBreak
SourceLine	A line or part of a line from the input source.
SourceLines	A set of lines (SourceLine) from the input source.
SourceSpan	A source span references a snippet of text from the source input.
SourceSpans	A list of source spans that can be added to.
SpecTestCase
StaggeredDelimiterProcessor	An implementation of DelimiterProcessor that dispatches all calls to two or more other DelimiterProcessors depending on the length of the delimiter run.
Strikethrough	A strikethrough node containing text and other inline nodes as children.
StrikethroughDelimiterProcessor
StrikethroughExtension	Extension for GFM strikethrough using ~ or ~~ (GitHub Flavored Markdown).
StrikethroughExtension.Builder
StrikethroughHtmlNodeRenderer
StrikethroughMarkdownNodeRenderer
StrikethroughNodeRenderer
StrikethroughTextContentNodeRenderer
StrongEmphasis
TableBlock	Table block containing a TableHead and optionally a TableBody.
TableBlockParser
TableBlockParser.Factory
TableBlockParser.TableCellInfo
TableBody	Body part of a TableBlock containing TableRows.
TableCell	Table cell of a TableRow containing inline nodes.
TableCell.Alignment	How the cell is aligned horizontally.
TableHead	Head part of a TableBlock containing TableRows.
TableHtmlNodeRenderer
TableMarkdownNodeRenderer	The Table node renderer that is needed for rendering GFM tables (GitHub Flavored Markdown) to text content.
TableNodeRenderer
TableRow	Table row of a TableHead or TableBody containing TableCells.
TablesExtension	Extension for GFM tables using "|" pipes (GitHub Flavored Markdown).
TableTextContentNodeRenderer	The Table node renderer that is needed for rendering GFM tables (GitHub Flavored Markdown) to text content.
TaskListItemHtmlNodeRenderer
TaskListItemMarker	A marker node indicating that a list item contains a task.
TaskListItemPostProcessor
TaskListItemPostProcessor.TaskListItemVisitor
TaskListItemsExtension	Extension for adding task list items.
TestResources
Text
TextContentNodeRendererContext
TextContentNodeRendererFactory	Factory for instantiating new node renderers when rendering is done.
TextContentRenderer	Renders nodes to plain text content with minimal markup-like additions.
TextContentRenderer.Builder	Builder for configuring a TextContentRenderer.
TextContentRenderer.TextContentRendererExtension	Extension for TextContentRenderer.
TextContentWriter
ThematicBreak
ThematicBreakParser
ThematicBreakParser.Factory
UnderscoreDelimiterProcessor
UrlSanitizer	Sanitizes urls for img and a elements by whitelisting protocols.
Visitor	Node visitor.
YamlFrontMatterBlock
YamlFrontMatterBlockParser
YamlFrontMatterBlockParser.Factory
YamlFrontMatterExtension	Extension for YAML-like metadata.
YamlFrontMatterNode
YamlFrontMatterVisitor