Package org.apache.maven.doxia.module.markdown

Interface MarkdownMarkup

All Superinterfaces:

org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.TextMarkup

All Known Implementing Classes:

MarkdownSink

public interface MarkdownMarkup
extends org.apache.maven.doxia.markup.TextMarkup

This interface defines all markups and syntaxes used by the Markdown format.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANCHOR_END_MARKUP	Syntax for the anchor end: "\"></a>"
static final String	ANCHOR_START_MARKUP	Syntax for the anchor start: "<a id=\""
static final char	BACKSLASH	backslash markup char: '\\'
static final String	BLANK_LINE
static final String	BLOCKQUOTE_START_MARKUP	Syntax for the blockquote start: "> "
static final String	BOLD_END_MARKUP	Syntax for the bold style end: "**"
static final String	BOLD_START_MARKUP	Syntax for the bold style start: "**"
static final String	COMMENT_END
static final String	COMMENT_START
static final String	HORIZONTAL_RULE_MARKUP	Syntax for the horizontal rule: "***"
static final String	INDENT	indentation e.g.
static final String	ITALIC_END_MARKUP	Syntax for the italic style end: "_"
static final String	ITALIC_START_MARKUP	Syntax for the italic style start: "_"
static final String	LINK_END_MARKUP	Syntax for the link end: ")"
static final String	LINK_START_1_MARKUP	Syntax for the link start: "["
static final String	LINK_START_2_MARKUP	Syntax for the link start: "]("
static final String	LIST_ORDERED_ITEM_START_MARKUP	Syntax for the ordered list item: '1.
static final String	LIST_UNORDERED_ITEM_START_MARKUP	Syntax for the unordered list item: "- "
static final String	METADATA_MARKUP	Syntax for the header start: "---"
static final String	MONOSPACED_END_MARKUP	Syntax for the mono-spaced style end: "`"
static final String	MONOSPACED_START_MARKUP	Syntax for the mono-spaced style start: "`"
static final String	NON_BREAKING_SPACE_MARKUP	Syntax for the non breaking space: entity from HTML
static final String	SECTION_TITLE_START_MARKUP	Syntax for the section title start: "#"
static final String	STRIKETHROUGH_END_MARKUP	Syntax for the strikethrough style end: "~~", https://github.github.com/gfm/#strikethrough-extension-
static final String	STRIKETHROUGH_START_MARKUP	Syntax for the strikethrough style start: "~~", https://github.github.com/gfm/#strikethrough-extension-
static final String	TABLE_CELL_SEPARATOR_MARKUP	Syntax for the table cell start: "|"
static final String	TABLE_COL_CENTER_ALIGNED_MARKUP	Syntax for the table column, center alignment: ":---:"
static final String	TABLE_COL_DEFAULT_ALIGNED_MARKUP	Syntax for the table column, default alignment (default): "---"
static final String	TABLE_COL_LEFT_ALIGNED_MARKUP	Syntax for the table column, left alignment (default): ":---"
static final String	TABLE_COL_RIGHT_ALIGNED_MARKUP	Syntax for the table column, right alignment: "---:"
static final String	TABLE_ROW_PREFIX	Syntax for the table row prefix (the other separators in the same row are regular TABLE_CELL_SEPARATOR_MARKUP characters)
static final String	VERBATIM_END_MARKUP	Syntax for the verbatim end: "```"
static final String	VERBATIM_START_MARKUP	Syntax for the verbatim start: "```"

Fields inherited from interface org.apache.maven.doxia.markup.Markup

COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR

Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup

PIPE

Field Details

BACKSLASH

static final char BACKSLASH

backslash markup char: '\\'

See Also:

• Constant Field Values

COMMENT_START

static final String COMMENT_START

See Also:

• Constant Field Values

COMMENT_END

static final String COMMENT_END

See Also:

• Constant Field Values

BLANK_LINE

static final String BLANK_LINE

INDENT

static final String INDENT

indentation e.g. for paragraphs inside lists

ANCHOR_END_MARKUP

static final String ANCHOR_END_MARKUP

Syntax for the anchor end: "\"></a>"

See Also:

• Constant Field Values

ANCHOR_START_MARKUP

static final String ANCHOR_START_MARKUP

Syntax for the anchor start: "<a id=\""

See Also:

• Constant Field Values

BOLD_END_MARKUP

static final String BOLD_END_MARKUP

Syntax for the bold style end: "**"

See Also:

• Constant Field Values

BOLD_START_MARKUP

static final String BOLD_START_MARKUP

Syntax for the bold style start: "**"

See Also:

• Constant Field Values

METADATA_MARKUP

static final String METADATA_MARKUP

Syntax for the header start: "---"

HORIZONTAL_RULE_MARKUP

static final String HORIZONTAL_RULE_MARKUP

Syntax for the horizontal rule: "***"

See Also:

• Constant Field Values

ITALIC_END_MARKUP

static final String ITALIC_END_MARKUP

Syntax for the italic style end: "_"

See Also:

• Constant Field Values

ITALIC_START_MARKUP

static final String ITALIC_START_MARKUP

Syntax for the italic style start: "_"

See Also:

• Constant Field Values

STRIKETHROUGH_END_MARKUP

static final String STRIKETHROUGH_END_MARKUP

Syntax for the strikethrough style end: "~~", https://github.github.com/gfm/#strikethrough-extension-

See Also:

• Constant Field Values

STRIKETHROUGH_START_MARKUP

static final String STRIKETHROUGH_START_MARKUP

Syntax for the strikethrough style start: "~~", https://github.github.com/gfm/#strikethrough-extension-

See Also:

• Constant Field Values

LINK_END_MARKUP

static final String LINK_END_MARKUP

Syntax for the link end: ")"

See Also:

• Constant Field Values

LINK_START_1_MARKUP

static final String LINK_START_1_MARKUP

Syntax for the link start: "["

See Also:

• Constant Field Values

LINK_START_2_MARKUP

static final String LINK_START_2_MARKUP

Syntax for the link start: "]("

See Also:

• Constant Field Values

LIST_ORDERED_ITEM_START_MARKUP

static final String LIST_ORDERED_ITEM_START_MARKUP

Syntax for the ordered list item: '1. '

See Also:

• Constant Field Values

LIST_UNORDERED_ITEM_START_MARKUP

static final String LIST_UNORDERED_ITEM_START_MARKUP

Syntax for the unordered list item: "- "

See Also:

• Constant Field Values

MONOSPACED_END_MARKUP

static final String MONOSPACED_END_MARKUP

Syntax for the mono-spaced style end: "`"

See Also:

• Constant Field Values

MONOSPACED_START_MARKUP

static final String MONOSPACED_START_MARKUP

Syntax for the mono-spaced style start: "`"

See Also:

• Constant Field Values

VERBATIM_START_MARKUP

static final String VERBATIM_START_MARKUP

Syntax for the verbatim start: "```"

See Also:

• Constant Field Values

VERBATIM_END_MARKUP

static final String VERBATIM_END_MARKUP

Syntax for the verbatim end: "```"

See Also:

• Constant Field Values

BLOCKQUOTE_START_MARKUP

static final String BLOCKQUOTE_START_MARKUP

Syntax for the blockquote start: "> "

See Also:

• Constant Field Values

NON_BREAKING_SPACE_MARKUP

static final String NON_BREAKING_SPACE_MARKUP

Syntax for the non breaking space: entity from HTML

See Also:

• Constant Field Values

SECTION_TITLE_START_MARKUP

static final String SECTION_TITLE_START_MARKUP

Syntax for the section title start: "#"

See Also:

• Constant Field Values

TABLE_CELL_SEPARATOR_MARKUP

static final String TABLE_CELL_SEPARATOR_MARKUP

Syntax for the table cell start: "|"

TABLE_COL_DEFAULT_ALIGNED_MARKUP

static final String TABLE_COL_DEFAULT_ALIGNED_MARKUP

Syntax for the table column, default alignment (default): "---"

TABLE_COL_LEFT_ALIGNED_MARKUP

static final String TABLE_COL_LEFT_ALIGNED_MARKUP

Syntax for the table column, left alignment (default): ":---"

TABLE_COL_RIGHT_ALIGNED_MARKUP

static final String TABLE_COL_RIGHT_ALIGNED_MARKUP

Syntax for the table column, right alignment: "---:"

TABLE_COL_CENTER_ALIGNED_MARKUP

static final String TABLE_COL_CENTER_ALIGNED_MARKUP

Syntax for the table column, center alignment: ":---:"

TABLE_ROW_PREFIX

static final String TABLE_ROW_PREFIX

Syntax for the table row prefix (the other separators in the same row are regular TABLE_CELL_SEPARATOR_MARKUP characters)