Package org.shredzone.commons.text.filter

Class GithubFlavoredMarkdownFilter

java.lang.Object

org.shredzone.commons.text.filter.MarkdownFilter

org.shredzone.commons.text.filter.GithubFlavoredMarkdownFilter

All Implemented Interfaces:

Function<CharSequence,CharSequence>, TextFilter

public class GithubFlavoredMarkdownFilter
extends MarkdownFilter

A filter that converts Markdown to HTML, but adding GitHub Flavored Markdown.

Since:

2.8

Author:

Richard "Shred" Körber

See Also:

GitHub Flavored Markdown Spec, commonmark-java

Constructor Summary

Constructors

Constructor	Description
GithubFlavoredMarkdownFilter()

Method Summary

Modifier and Type	Method	Description
protected List<org.commonmark.Extension>	createExtensionList()	Creates a list of markdown extensions to be used.
void	setAutolinkEnabled(boolean autolink)	Enables the autolink extension.

Methods inherited from class org.shredzone.commons.text.filter.MarkdownFilter

apply, createHtmlRendererBuilder, createParserBuilder, setAnalyzer, setPreClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.shredzone.commons.text.TextFilter

toStringBuilder

Constructor Details

GithubFlavoredMarkdownFilter

public GithubFlavoredMarkdownFilter()

Method Details

setAutolinkEnabled

public void setAutolinkEnabled(boolean autolink)

Enables the autolink extension. It is disabled by default, to give the user full control about link placement in the text.

Parameters:

autolink - true to enable the autolink extension. false by default.

createExtensionList

protected List<org.commonmark.Extension> createExtensionList()

Description copied from class: MarkdownFilter

Creates a list of markdown extensions to be used. By default this list is empty. Subclasses may add extensions to the list.

Note that this method is commonmark specific and might be removed in future versions.

Overrides:

createExtensionList in class MarkdownFilter

Returns:

Modifiable List of extensions