Package 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:

MacroExecutor, Markup, TextMarkup, Parser

@Singleton
@Named("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 Xhtml5 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	Description
static class	MarkdownParser.MarkdownHtmlParser	Internal parser for HTML generated by the Markdown library.

Field Summary

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

TXT_TYPE, UNKNOWN_TYPE, XML_TYPE

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

PIPE

Constructor Summary

Constructors

Constructor	Description
MarkdownParser()

Method Summary

Modifier and Type	Method	Description
void	parse(Reader source, Sink sink, String reference)	Parses the given source model and emits Doxia events into the given sink.

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

getType

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

addSinkWrapperFactory, doxiaVersion, executeMacro, getBasedir, getMacroManager, getSinkWrapperFactories, getWrappedSink, init, isEmitAnchorsForIndexableEntries, isEmitComments, isSecondParsing, parse, parse, parse, setEmitAnchorsForIndexableEntries, setEmitComments, setMacroExecutor, setSecondParsing

Methods inherited from class java.lang.Object

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

Constructor Details

MarkdownParser

public MarkdownParser()

Method Details

parse

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

Description copied from interface: Parser

Parses the given source model and emits Doxia events into the given sink.

Specified by:

parse in interface Parser

Parameters:

source - not null reader that provides the source document.

sink - A sink that consumes the Doxia events.

reference - a string identifying the source (for file based documents the source file path)

Throws:

ParseException - if the model could not be parsed.