Package org.commonmark.ext.footnotes

Class FootnotesExtension

java.lang.Object

org.commonmark.ext.footnotes.FootnotesExtension

All Implemented Interfaces:

Extension, Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, MarkdownRenderer.MarkdownRendererExtension

public class FootnotesExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, MarkdownRenderer.MarkdownRendererExtension

Extension for footnotes with syntax like GitHub Flavored Markdown:

 Some text with a footnote[^1].

 [^1]: The text of the footnote.
 

The [^1] is a FootnoteReference, with "1" being the label.

The line with [^1]: ... is a FootnoteDefinition, with the contents as child nodes (can be a paragraph like in the example, or other blocks like lists).

All the footnotes (definitions) will be rendered in a list at the end of a document, no matter where they appear in the source. The footnotes will be numbered starting from 1, then 2, etc, depending on the order in which they appear in the text (and not dependent on the label). The footnote reference is a link to the footnote, and from the footnote there is a link back to the reference (or multiple).

There is also optional support for inline footnotes, use builder() and then set FootnotesExtension.Builder.inlineFootnotes.

See Also:

• GitHub docs for footnotes

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FootnotesExtension.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	inlineFootnotes

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FootnotesExtension(boolean inlineFootnotes)

Method Summary

Modifier and Type	Method	Description
static FootnotesExtension.Builder	builder()
static Extension	create()	The extension with the default configuration (no support for inline footnotes).
void	extend(Parser.Builder parserBuilder)
void	extend(HtmlRenderer.Builder rendererBuilder)
void	extend(MarkdownRenderer.Builder rendererBuilder)	Extend Markdown rendering, usually by registering custom node renderers using MarkdownRenderer.Builder.nodeRendererFactory(org.commonmark.renderer.markdown.MarkdownNodeRendererFactory).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

inlineFootnotes

private final boolean inlineFootnotes

Constructor Details

FootnotesExtension

private FootnotesExtension(boolean inlineFootnotes)

Method Details

create

public static Extension create()

The extension with the default configuration (no support for inline footnotes).

builder

public static FootnotesExtension.Builder builder()

extend

public void extend(Parser.Builder parserBuilder)

Specified by:

extend in interface Parser.ParserExtension

extend

public void extend(HtmlRenderer.Builder rendererBuilder)

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension

extend

public void extend(MarkdownRenderer.Builder rendererBuilder)

Description copied from interface: MarkdownRenderer.MarkdownRendererExtension

Extend Markdown rendering, usually by registering custom node renderers using MarkdownRenderer.Builder.nodeRendererFactory(org.commonmark.renderer.markdown.MarkdownNodeRendererFactory).

Specified by:

extend in interface MarkdownRenderer.MarkdownRendererExtension

Parameters:

rendererBuilder - the renderer builder to extend