Package org.jdrupes.mdoclet

Schnittstelle MarkdownProcessor

Alle Superschnittstellen:

OptionChecker

Alle bekannten Implementierungsklassen:

FlexmarkProcessor

public interface MarkdownProcessor
extends OptionChecker

Provides the interface to the Markdown processor.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	INTERNAL_OPT_DISABLE_AUTO_HIGHLIGHT

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	start(String[] options)	Starts the processor with the given options.
String	toHtml(String markdown)	Converts the given markdown text to HTML.
String	toHtmlFragment(String markdown)	Converts the given markdown snippet to HTML.

Von Schnittstelle geerbte Methoden javax.tools.OptionChecker

isSupportedOption

Felddetails

INTERNAL_OPT_DISABLE_AUTO_HIGHLIGHT

static final String INTERNAL_OPT_DISABLE_AUTO_HIGHLIGHT

Siehe auch:

• Konstantenfeldwerte

Methodendetails

start

void start(String[] options)

Starts the processor with the given options.

All processors should support the special option _disable-auto-highlight_. The doclet maps its option -disable-auto-highlight to this special processor option because disabling the auto highlight feature is usually implemented by configuring the processors HTML renderer in some way.

Parameter:

options - an array of options

toHtml

String toHtml(String markdown)

Converts the given markdown text to HTML.

Parameter:

markdown - the markdown text

Gibt zurück:

the HTML

toHtmlFragment

String toHtmlFragment(String markdown)

Converts the given markdown snippet to HTML.

If the text does not start with an HTML tag, the markdown processor will most likely surround it with an additional block tag such as a paragraph tag. This method should return a result where any additional tag is removed.

Parameter:

markdown - the markdown text

Gibt zurück:

the HTML

Seit:

2.0