Module org.commonmark.ext.gfm.alerts

Package org.commonmark.ext.gfm.alerts

Class AlertsExtension

java.lang.Object

org.commonmark.ext.gfm.alerts.AlertsExtension

All Implemented Interfaces:

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

public class AlertsExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, TextContentRenderer.TextContentRendererExtension, MarkdownRenderer.MarkdownRendererExtension

Extension for GFM alerts using [!TYPE] syntax (GitHub Flavored Markdown).

Create with create() or builder() and configure on builders (Parser.Builder.extensions(Iterable), HtmlRenderer.Builder.extensions(Iterable)). Parsed alerts become Alert blocks. If custom alert titles are allowed via AlertsExtension.Builder.allowCustomTitles(boolean), the inline formatting of those titles will be parsed into AlertTitle nodes.

The default configuration of this extension will match GFM exactly, with the following exceptions:

- Alert markers take precedence over shortcut reference links. - Alerts with no content are allowed. Example:

 <!-- Valid -->
 > [!NOTE]

 <!-- Also valid if custom titles are allowed -->
 > [!NOTE] Custom title

 

- Lazy continuation is not allowed between the marker and the body text. Example:

 > [!NOTE]
 Lazy body text will be parsed as a new paragraph

 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AlertsExtension.Builder	Builder for configuring the alerts extension.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,String>	allowedTypes	A map of alert marker ([!TYPE]) to the default title for that marker.
private final boolean	customTitlesAllowed
private final boolean	nestedAlertsAllowed
static final Map<String,String>	STANDARD_TYPES	The standard GitHub Flavored Markdown (GFM) types that the extension enables by default.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AlertsExtension(AlertsExtension.Builder builder)

Method Summary

Modifier and Type	Method	Description
static AlertsExtension.Builder	builder()
static Extension	create()
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).
void	extend(TextContentRenderer.Builder rendererBuilder)

Methods inherited from class java.lang.Object

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

Field Details

STANDARD_TYPES

public static final Map<String,String> STANDARD_TYPES

The standard GitHub Flavored Markdown (GFM) types that the extension enables by default. These can be overwritten with AlertsExtension.Builder.setAllowedTypes(Map).

allowedTypes

private final Map<String,String> allowedTypes

A map of alert marker ([!TYPE]) to the default title for that marker.

customTitlesAllowed

private final boolean customTitlesAllowed

nestedAlertsAllowed

private final boolean nestedAlertsAllowed

Constructor Details

AlertsExtension

private AlertsExtension(AlertsExtension.Builder builder)

Method Details

create

public static Extension create()

builder

public static AlertsExtension.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(TextContentRenderer.Builder rendererBuilder)

Specified by:

extend in interface TextContentRenderer.TextContentRendererExtension

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