Package org.concordion.api.option

Enum Class MarkdownExtensions

java.lang.Object

java.lang.Enum<MarkdownExtensions>

org.concordion.api.option.MarkdownExtensions

All Implemented Interfaces:

Serializable, Comparable<MarkdownExtensions>, Constable

public enum MarkdownExtensions
extends Enum<MarkdownExtensions>

Extensions to the Markdown language that can be enabled for Concordion Markdown.

Note that the following extensions are enabled by default:

• TABLES - similar to what MultiMarkdown offers.
• STRIKETHROUGH - ~~strikethroughs~~ as supported in Pandoc and Github.

The SMARTS, QUOTES and SMARTYPANTS extensions from Pegdown are currently not supported in Concordion Markdown, since the XOM parser fails due to unknown entity references for these characters.

Since:

2.0.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABBREVIATIONS	PHP Markdown Extra style abbreviations.
ANCHORLINKS	Generate anchor links for headers by taking the first range of alphanumerics and spaces.
ATXHEADERSPACE	Requires a space char after Atx # header prefixes, so that #dasdsdaf is not a header.
AUTOLINKS	Enables plain autolinks the way github flavoured markdown implements them.
DEFINITIONS	PHP Markdown Extra style definition lists.
EXTANCHORLINKS	Generate anchor links for headers using complete contents of the header.
FENCED_CODE_BLOCKS	PHP Markdown Extra style fenced code blocks.
FORCELISTITEMPARA	Wrap a list item or definition term in
HARDWRAPS	Enables the parsing of hard wraps as HTML linebreaks.
NONE	The default, standard markup mode without any extensions.
RELAXEDHRULES	Allow horizontal rules without a blank line following them.
SUPPRESS_ALL_HTML	Suppresses HTML blocks as well as inline HTML tags.
SUPPRESS_HTML_BLOCKS	Suppresses HTML blocks.
SUPPRESS_INLINE_HTML	Suppresses inline HTML tags.
TASKLISTITEMS	GitHub style task list items: - [ ] and - [x]
WIKILINKS	Support [[Wiki-style links]].

Method Summary

Modifier and Type	Method	Description
int	getPegdownExtension()
static MarkdownExtensions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MarkdownExtensions[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final MarkdownExtensions NONE

The default, standard markup mode without any extensions.

ABBREVIATIONS

public static final MarkdownExtensions ABBREVIATIONS

PHP Markdown Extra style abbreviations.

See Also:

• PHP Markdown Extra

HARDWRAPS

public static final MarkdownExtensions HARDWRAPS

Enables the parsing of hard wraps as HTML linebreaks. Similar to what Github does.

See Also:

• Github-flavored-Markdown

AUTOLINKS

public static final MarkdownExtensions AUTOLINKS

Enables plain autolinks the way github flavoured markdown implements them. With this extension enabled pegdown will intelligently recognize URLs and email addresses without any further delimiters and mark them as the respective link type.

See Also:

• Github-flavored-Markdown

DEFINITIONS

public static final MarkdownExtensions DEFINITIONS

PHP Markdown Extra style definition lists. Additionally supports the small extension proposed in the article referenced below.

See Also:

• PHP Markdown Extra
• Extension proposal

FENCED_CODE_BLOCKS

public static final MarkdownExtensions FENCED_CODE_BLOCKS

PHP Markdown Extra style fenced code blocks.

See Also:

• PHP Markdown Extra

WIKILINKS

public static final MarkdownExtensions WIKILINKS

Support [[Wiki-style links]]. URL rendering is performed by the active LinkRenderer.

See Also:

• Github-flavored-Markdown

ANCHORLINKS

public static final MarkdownExtensions ANCHORLINKS

Generate anchor links for headers by taking the first range of alphanumerics and spaces.

EXTANCHORLINKS

public static final MarkdownExtensions EXTANCHORLINKS

Generate anchor links for headers using complete contents of the header.

• Spaces and non-alphanumerics replaced by -, multiple dashes trimmed to one.
• Anchor link is added as first element inside the header with empty content: <h1><a name="header"></a>header</h1>

SUPPRESS_HTML_BLOCKS

public static final MarkdownExtensions SUPPRESS_HTML_BLOCKS

Suppresses HTML blocks. They will be accepted in the input but not be contained in the output.

SUPPRESS_INLINE_HTML

public static final MarkdownExtensions SUPPRESS_INLINE_HTML

Suppresses inline HTML tags. They will be accepted in the input but not be contained in the output.

SUPPRESS_ALL_HTML

public static final MarkdownExtensions SUPPRESS_ALL_HTML

Suppresses HTML blocks as well as inline HTML tags. Both will be accepted in the input but not be contained in the output.

ATXHEADERSPACE

public static final MarkdownExtensions ATXHEADERSPACE

Requires a space char after Atx # header prefixes, so that #dasdsdaf is not a header.

FORCELISTITEMPARA

public static final MarkdownExtensions FORCELISTITEMPARA

Wrap a list item or definition term in

tags if it contains more than a simple paragraph.

RELAXEDHRULES

public static final MarkdownExtensions RELAXEDHRULES

Allow horizontal rules without a blank line following them.

TASKLISTITEMS

public static final MarkdownExtensions TASKLISTITEMS

GitHub style task list items: - [ ] and - [x]

Method Details

values

public static MarkdownExtensions[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MarkdownExtensions valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getPegdownExtension

public int getPegdownExtension()