org.commonmark.ext.gfm.strikethrough

Class StrikethroughExtension

java.lang.Object

org.commonmark.ext.gfm.strikethrough.StrikethroughExtension

All Implemented Interfaces:

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

public class StrikethroughExtension
extends java.lang.Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, TextContentRenderer.TextContentRendererExtension

Extension for GFM strikethrough using ~~ (GitHub Flavored Markdown).

Create it with create() and then configure it on the builders (Parser.Builder.extensions(Iterable), HtmlRenderer.Builder#extensions(Iterable)).

The parsed strikethrough text regions are turned into Strikethrough nodes.

Method Summary

Modifier and Type	Method and Description
static Extension	create()
void	extend(HtmlRenderer.Builder rendererBuilder)
void	extend(Parser.Builder parserBuilder)
void	extend(TextContentRenderer.Builder rendererBuilder)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Extension create()

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