org.apache.maven.doxia.module.markdown

Class MarkdownParser

java.lang.Object

org.apache.maven.doxia.parser.AbstractParser

org.apache.maven.doxia.parser.AbstractTextParser

org.apache.maven.doxia.module.markdown.MarkdownParser

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, Markup, TextMarkup, Parser

@Component(role=org.apache.maven.doxia.parser.Parser.class,
           hint="markdown")
public class MarkdownParser
extends AbstractTextParser
implements TextMarkup

Implementation of Parser for Markdown documents.

Defers effective parsing to the flexmark-java library, which generates HTML content then delegates parsing of this content to a slightly modified Doxia Xhtml parser. (before 1.8, the PegDown library was used)

Since:

1.3

Author:

Vladimir Schneider, Julien Nicoulaud

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarkdownParser.MarkdownHtmlParser Internal parser for HTML generated by the Markdown library.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE_HINT The role hint for the MarkdownParser Plexus component.

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

PIPE

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.parser.Parser

ROLE, TXT_TYPE, UNKNOWN_TYPE, XML_TYPE

Constructor Summary

Constructors

Constructor and Description
MarkdownParser()

Method Summary

Modifier and Type	Method and Description
void	parse(Reader source, Sink sink, String reference)

Methods inherited from class org.apache.maven.doxia.parser.AbstractTextParser

getType

Methods inherited from class org.apache.maven.doxia.parser.AbstractParser

doxiaVersion, enableLogging, executeMacro, getBasedir, getLog, getMacroManager, init, isEmitComments, isSecondParsing, parse, parse, parse, setEmitComments, setSecondParsing

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_HINT

public static final String ROLE_HINT

The role hint for the MarkdownParser Plexus component.

See Also:

Constant Field Values

Constructor Detail

MarkdownParser

public MarkdownParser()

Method Detail

parse

public void parse(Reader source,
                  Sink sink,
                  String reference)
           throws ParseException

Specified by:

parse in interface Parser

Throws:

ParseException