Package org.concordion.api.option
Enum Class MarkdownExtensions
- All Implemented Interfaces:
Serializable
,Comparable<MarkdownExtensions>
,Constable
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 ConstantDescriptionPHP Markdown Extra style abbreviations.Generate anchor links for headers by taking the first range of alphanumerics and spaces.Requires a space char after Atx # header prefixes, so that #dasdsdaf is not a header.Enables plain autolinks the way github flavoured markdown implements them.PHP Markdown Extra style definition lists.Generate anchor links for headers using complete contents of the header.PHP Markdown Extra style fenced code blocks.Wrap a list item or definition term inEnables the parsing of hard wraps as HTML linebreaks.The default, standard markup mode without any extensions.Allow horizontal rules without a blank line following them.Suppresses HTML blocks as well as inline HTML tags.Suppresses HTML blocks.Suppresses inline HTML tags.GitHub style task list items: - [ ] and - [x]Support [[Wiki-style links]]. -
Method Summary
Modifier and TypeMethodDescriptionint
static MarkdownExtensions
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.
-
Enum Constant Details
-
NONE
The default, standard markup mode without any extensions. -
ABBREVIATIONS
PHP Markdown Extra style abbreviations.- See Also:
-
HARDWRAPS
Enables the parsing of hard wraps as HTML linebreaks. Similar to what Github does.- See Also:
-
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:
-
DEFINITIONS
PHP Markdown Extra style definition lists. Additionally supports the small extension proposed in the article referenced below.- See Also:
-
FENCED_CODE_BLOCKS
PHP Markdown Extra style fenced code blocks.- See Also:
-
WIKILINKS
Support [[Wiki-style links]]. URL rendering is performed by the active LinkRenderer.- See Also:
-
ANCHORLINKS
Generate anchor links for headers by taking the first range of alphanumerics and spaces. -
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
Suppresses HTML blocks. They will be accepted in the input but not be contained in the output. -
SUPPRESS_INLINE_HTML
Suppresses inline HTML tags. They will be accepted in the input but not be contained in the output. -
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
Requires a space char after Atx # header prefixes, so that #dasdsdaf is not a header. -
FORCELISTITEMPARA
Wrap a list item or definition term intags if it contains more than a simple paragraph.
-
RELAXEDHRULES
Allow horizontal rules without a blank line following them. -
TASKLISTITEMS
GitHub style task list items: - [ ] and - [x]
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getPegdownExtension
public int getPegdownExtension()
-