Package org.adempiere.base.markdown

Interface IMarkdownRenderer

All Known Implementing Classes:

MarkdownRendererImpl

public interface IMarkdownRenderer

Markdown rendering interface

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MARKDOWN_CLOSING_TAG
static final String	MARKDOWN_OPENING_TAG

Method Summary

Modifier and Type	Method	Description
default String	renderToHtml(String inputText)	Render inputText with markdown to html (with table and autolink extension)
default String	renderToHtml(String inputText, boolean autoLink)
String	renderToHtml(String inputText, boolean autoLink, String baseURL)	Render inputText with markdown to html (with table and optional autolink extension)

Field Details

MARKDOWN_OPENING_TAG

static final String MARKDOWN_OPENING_TAG

See Also:

• Constant Field Values

MARKDOWN_CLOSING_TAG

static final String MARKDOWN_CLOSING_TAG

See Also:

• Constant Field Values

Method Details

renderToHtml

default String renderToHtml(String inputText)

Render inputText with markdown to html (with table and autolink extension)

Parameters:

inputText -

Returns:

html

renderToHtml

default String renderToHtml(String inputText,
 boolean autoLink)

Parameters:

inputText -

autoLink -

Returns:

html

renderToHtml

String renderToHtml(String inputText,
 boolean autoLink,
 String baseURL)

Render inputText with markdown to html (with table and optional autolink extension)

Parameters:

inputText -

autoLink - true to enable autolink extension

baseURL - base URL for relative links

Returns:

html