Class FlexmarkHtmlConverter

java.lang.Object

com.vladsch.flexmark.html2md.converter.FlexmarkHtmlConverter

public class FlexmarkHtmlConverter
extends Object

Renders a tree of nodes to HTML.

Start with the builder() method to configure the renderer. Example:

HtmlRenderer renderer = builder().escapeHtml(true).build();
renderer.render(node);

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlexmarkHtmlConverter.Builder	Builder for configuring an FlexmarkHtmlConverter.
static interface	FlexmarkHtmlConverter.HtmlConverterExtension	Extension for FlexmarkHtmlConverter.
private class	FlexmarkHtmlConverter.MainHtmlConverter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	A_NODE
static final String	ABBR_NODE
static final DataKey<Boolean>	ADD_TRAILING_EOL
static final String	ASIDE_NODE
static final String	B_NODE
static final String	BLOCKQUOTE_NODE
static final DataKey<Boolean>	BR_AS_EXTRA_BLANK_LINES
static final DataKey<Boolean>	BR_AS_PARA_BREAKS
static final String	BR_NODE
static final String	CAPTION_NODE
static final DataKey<String>	CODE_INDENT
static final String	CODE_NODE
static final String	COMMENT_NODE
static final DataKey<Boolean>	COMMENT_ORIGINAL_NON_NUMERIC_LIST_ITEM
static final String	DD_NODE
static final String	DEFAULT_NODE
static final DataKey<Integer>	DEFINITION_MARKER_SPACES
static final String	DEL_NODE
static final DataKey<Boolean>	DIV_AS_PARAGRAPH
static final String	DIV_NODE
static final DataKey<String[]>	DIV_TABLE_CELL_CLASSES
static final DataKey<String[]>	DIV_TABLE_HDR_CLASSES
static final DataKey<Boolean>	DIV_TABLE_PROCESSING
static final DataKey<String[]>	DIV_TABLE_ROW_CLASSES
static final String	DL_NODE
static final DataKey<Boolean>	DOT_ONLY_NUMERIC_LISTS
static final String	DT_NODE
static final DataKey<Boolean>	DUMP_HTML_TREE	if true then will dump HTML tree of body element to console when using convert(String, Appendable)(String)
static final String	EM_NODE
static final String	EMOJI_NODE
static final DataKey<String>	EOL_IN_TITLE_ATTRIBUTE
static String[]	EXPLICIT_LINK_TEXT_TAGS
static final DataKey<ExtensionConversion>	EXT_INLINE_CODE
static final DataKey<ExtensionConversion>	EXT_INLINE_DEL
static final DataKey<ExtensionConversion>	EXT_INLINE_EMPHASIS
static final DataKey<LinkConversion>	EXT_INLINE_IMAGE
static final DataKey<ExtensionConversion>	EXT_INLINE_INS
static final DataKey<LinkConversion>	EXT_INLINE_LINK
static final DataKey<ExtensionConversion>	EXT_INLINE_STRONG
static final DataKey<ExtensionConversion>	EXT_INLINE_SUB
static final DataKey<ExtensionConversion>	EXT_INLINE_SUP
static final DataKey<ExtensionConversion>	EXT_MATH
static final DataKey<ExtensionConversion>	EXT_TABLES
static final DataKey<Boolean>	EXTRACT_AUTO_LINKS
static final DataKey<Ref<Document>>	FOR_DOCUMENT
static final DataKey<Integer>	FORMAT_FLAGS	output control for FormattingAppendable, see LineAppendable.setOptions(int)
static final String	H1_NODE
static final String	H2_NODE
static final String	H3_NODE
static final String	H4_NODE
static final String	H5_NODE
static final String	H6_NODE
static final String[]	HEADING_NODES
static final String	HR_NODE
(package private) final HtmlConverterOptions	htmlConverterOptions
static final String	I_NODE
static final DataKey<Boolean>	IGNORE_TABLE_HEADING_AFTER_ROWS	If true then will ignore rows with th columns after rows with td columns have been emitted to the table.
static final String	IMG_NODE
static final String	INPUT_NODE
static final String	INS_NODE
static final String	LI_NODE
(package private) final List<HtmlLinkResolverFactory>	linkResolverFactories
static final DataKey<Boolean>	LIST_CONTENT_INDENT
static final DataKey<Integer>	LIST_ITEM_INDENT
static final DataKey<Boolean>	LISTS_END_ON_DOUBLE_BLANK
static final String	MATH_NODE
static final DataKey<Integer>	MAX_BLANK_LINES
static final DataKey<Integer>	MAX_TRAILING_BLANK_LINES
static final DataKey<Integer>	MIN_SETEXT_HEADING_MARKER_LENGTH
static final DataKey<String>	NBSP_TEXT
(package private) final List<DelegatingNodeRendererFactoryWrapper>	nodeRendererFactories
static final Iterable<org.jsoup.nodes.Node>	NULL_ITERABLE
private static final Iterator<org.jsoup.nodes.Node>	NULL_ITERATOR
static final String	OL_NODE
private final DataHolder	options
static final DataKey<Character>	ORDERED_LIST_DELIMITER
static final DataKey<Boolean>	OUTPUT_ATTRIBUTES_ID
static final DataKey<String>	OUTPUT_ATTRIBUTES_NAMES_REGEX
static final DataKey<String>	OUTPUT_ID_ATTRIBUTE_REGEX
static final DataKey<Boolean>	OUTPUT_UNKNOWN_TAGS
static final String	P_NODE
static final DataKey<Boolean>	PRE_CODE_PRESERVE_EMPHASIS
static final String	PRE_NODE
static final DataKey<Boolean>	RENDER_COMMENTS
static final DataKey<Boolean>	SETEXT_HEADINGS
static final DataKey<Boolean>	SKIP_ATTRIBUTES
static final DataKey<Boolean>	SKIP_CHAR_ESCAPE
static final DataKey<Boolean>	SKIP_FENCED_CODE
static final DataKey<Boolean>	SKIP_HEADING_1
static final DataKey<Boolean>	SKIP_HEADING_2
static final DataKey<Boolean>	SKIP_HEADING_3
static final DataKey<Boolean>	SKIP_HEADING_4
static final DataKey<Boolean>	SKIP_HEADING_5
static final DataKey<Boolean>	SKIP_HEADING_6
static final String	SPAN_NODE
(package private) static final Map<String,String>	SPECIAL_CHARS_MAP
static final String	STRIKE_NODE
static final String	STRONG_NODE
static final String	SUB_NODE
static final String	SUP_NODE
static final String	SVG_NODE
static final DataKey<TableCaptionHandling>	TABLE_CAPTION	Deprecated.
static final DataKey<Map<Object, CellAlignment>>	TABLE_CELL_ALIGNMENT_MAP
private static final Map<Object, CellAlignment>	TABLE_CELL_ALIGNMENTS
static final DataKey<Boolean>	TABLE_LEAD_TRAIL_PIPES	Deprecated.
static final DataKey<Integer>	TABLE_MIN_SEPARATOR_COLUMN_WIDTH	Deprecated.
static final DataKey<Integer>	TABLE_MIN_SEPARATOR_DASHES	Deprecated.
static final String	TABLE_NODE
static final DataKey<Boolean>	TABLE_SPACE_AROUND_PIPES	Deprecated.
static final String	TBODY_NODE
static final String	TD_NODE
static final String	TEXT_NODE
static final String	TH_NODE
static final String	THEAD_NODE
static final DataKey<String>	THEMATIC_BREAK
static final String	TR_NODE
static final DataKey<Boolean>	TYPOGRAPHIC_QUOTES
private static final String	TYPOGRAPHIC_QUOTES_PIPED
static final DataKey<Map<String,String>>	TYPOGRAPHIC_REPLACEMENT_MAP
static final DataKey<Boolean>	TYPOGRAPHIC_SMARTS
private static final String	TYPOGRAPHIC_SMARTS_PIPED
static final String	U_NODE
static final String	UL_NODE
static final DataKey<Character>	UNORDERED_LIST_DELIMITER
static final DataKey<String[]>	UNWRAPPED_TAGS
static final DataKey<Boolean>	WRAP_AUTO_LINKS
static final DataKey<String[]>	WRAPPED_TAGS

Constructor Summary

Constructors

Constructor	Description
FlexmarkHtmlConverter(FlexmarkHtmlConverter.Builder builder)

Method Summary

Modifier and Type	Method	Description
(package private) static void	appendOuterHtml(@NotNull HtmlNodeConverterSubContext context, @NotNull org.jsoup.nodes.Node node)
static FlexmarkHtmlConverter.Builder	builder()	Create a new builder for configuring an FlexmarkHtmlConverter.
static FlexmarkHtmlConverter.Builder	builder(DataHolder options)	Create a new builder for configuring an FlexmarkHtmlConverter.
String	convert(@NotNull String html)	Parse HTML with default options
String	convert(@NotNull String html, int maxTrailingBlankLines)	Parse HTML with given options and max trailing blank lines
void	convert(@NotNull String html, @NotNull Appendable output)	Render a node to the appendable
String	convert(org.jsoup.nodes.Node node)	Render the tree of nodes to markdown
void	convert(org.jsoup.nodes.Node node, Appendable output, int maxTrailingBlankLines)	Render a node to the appendable
static void	dumpHtmlTree(LineAppendable out, org.jsoup.nodes.Node node)
(package private) static String	dumpState(@NotNull HtmlNodeConverterContext context)
DataHolder	getOptions()
(package private) static void	processConditional(@NotNull HtmlNodeConverterContext context, @NotNull ExtensionConversion extensionConversion, @NotNull org.jsoup.nodes.Node node, @NotNull Runnable processNode)
(package private) static void	processDefault(@NotNull HtmlNodeConverterSubContext subContext, @NotNull org.jsoup.nodes.Node node, boolean outputUnknownTags)
(package private) static void	processHtmlTree(@NotNull HtmlNodeConverterSubContext context, @NotNull org.jsoup.nodes.Node parent, boolean outputAttributes, @Nullable Runnable prePopAction)
(package private) static void	processTextNodes(@NotNull HtmlNodeConverterContext context, @NotNull org.jsoup.nodes.Node node, boolean stripIdAttribute, @Nullable CharSequence textPrefix, @Nullable CharSequence textSuffix)
static void	processWrapped(@NotNull HtmlNodeConverterSubContext context, @NotNull org.jsoup.nodes.Node node, @Nullable Boolean isBlock, boolean escapeMarkdown)
(package private) static void	wrapTextNodes(@NotNull HtmlNodeConverterContext context, @NotNull org.jsoup.nodes.Node node, @NotNull CharSequence wrapText, boolean needSpaceAround)

Methods inherited from class Object

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

Field Details

FORMAT_FLAGS

public static final DataKey<Integer> FORMAT_FLAGS

output control for FormattingAppendable, see LineAppendable.setOptions(int)

MAX_BLANK_LINES

public static final DataKey<Integer> MAX_BLANK_LINES

MAX_TRAILING_BLANK_LINES

public static final DataKey<Integer> MAX_TRAILING_BLANK_LINES

LIST_CONTENT_INDENT

public static final DataKey<Boolean> LIST_CONTENT_INDENT

SETEXT_HEADINGS

public static final DataKey<Boolean> SETEXT_HEADINGS

OUTPUT_UNKNOWN_TAGS

public static final DataKey<Boolean> OUTPUT_UNKNOWN_TAGS

TYPOGRAPHIC_QUOTES

public static final DataKey<Boolean> TYPOGRAPHIC_QUOTES

TYPOGRAPHIC_SMARTS

public static final DataKey<Boolean> TYPOGRAPHIC_SMARTS

EXTRACT_AUTO_LINKS

public static final DataKey<Boolean> EXTRACT_AUTO_LINKS

OUTPUT_ATTRIBUTES_ID

public static final DataKey<Boolean> OUTPUT_ATTRIBUTES_ID

OUTPUT_ATTRIBUTES_NAMES_REGEX

public static final DataKey<String> OUTPUT_ATTRIBUTES_NAMES_REGEX

WRAP_AUTO_LINKS

public static final DataKey<Boolean> WRAP_AUTO_LINKS

RENDER_COMMENTS

public static final DataKey<Boolean> RENDER_COMMENTS

DOT_ONLY_NUMERIC_LISTS

public static final DataKey<Boolean> DOT_ONLY_NUMERIC_LISTS

COMMENT_ORIGINAL_NON_NUMERIC_LIST_ITEM

public static final DataKey<Boolean> COMMENT_ORIGINAL_NON_NUMERIC_LIST_ITEM

PRE_CODE_PRESERVE_EMPHASIS

public static final DataKey<Boolean> PRE_CODE_PRESERVE_EMPHASIS

ORDERED_LIST_DELIMITER

public static final DataKey<Character> ORDERED_LIST_DELIMITER

UNORDERED_LIST_DELIMITER

public static final DataKey<Character> UNORDERED_LIST_DELIMITER

DEFINITION_MARKER_SPACES

public static final DataKey<Integer> DEFINITION_MARKER_SPACES

MIN_SETEXT_HEADING_MARKER_LENGTH

public static final DataKey<Integer> MIN_SETEXT_HEADING_MARKER_LENGTH

LIST_ITEM_INDENT

public static final DataKey<Integer> LIST_ITEM_INDENT

CODE_INDENT

public static final DataKey<String> CODE_INDENT

NBSP_TEXT

public static final DataKey<String> NBSP_TEXT

EOL_IN_TITLE_ATTRIBUTE

public static final DataKey<String> EOL_IN_TITLE_ATTRIBUTE

THEMATIC_BREAK

public static final DataKey<String> THEMATIC_BREAK

UNWRAPPED_TAGS

public static final DataKey<String[]> UNWRAPPED_TAGS

WRAPPED_TAGS

public static final DataKey<String[]> WRAPPED_TAGS

OUTPUT_ID_ATTRIBUTE_REGEX

public static final DataKey<String> OUTPUT_ID_ATTRIBUTE_REGEX

TABLE_MIN_SEPARATOR_COLUMN_WIDTH

@Deprecated
public static final DataKey<Integer> TABLE_MIN_SEPARATOR_COLUMN_WIDTH

Deprecated.

TABLE_MIN_SEPARATOR_DASHES

@Deprecated
public static final DataKey<Integer> TABLE_MIN_SEPARATOR_DASHES

Deprecated.

TABLE_LEAD_TRAIL_PIPES

@Deprecated
public static final DataKey<Boolean> TABLE_LEAD_TRAIL_PIPES

Deprecated.

TABLE_SPACE_AROUND_PIPES

@Deprecated
public static final DataKey<Boolean> TABLE_SPACE_AROUND_PIPES

Deprecated.

TABLE_CAPTION

@Deprecated
public static final DataKey<TableCaptionHandling> TABLE_CAPTION

Deprecated.

LISTS_END_ON_DOUBLE_BLANK

public static final DataKey<Boolean> LISTS_END_ON_DOUBLE_BLANK

DIV_AS_PARAGRAPH

public static final DataKey<Boolean> DIV_AS_PARAGRAPH

BR_AS_PARA_BREAKS

public static final DataKey<Boolean> BR_AS_PARA_BREAKS

BR_AS_EXTRA_BLANK_LINES

public static final DataKey<Boolean> BR_AS_EXTRA_BLANK_LINES

DIV_TABLE_PROCESSING

public static final DataKey<Boolean> DIV_TABLE_PROCESSING

DIV_TABLE_HDR_CLASSES

public static final DataKey<String[]> DIV_TABLE_HDR_CLASSES

DIV_TABLE_ROW_CLASSES

public static final DataKey<String[]> DIV_TABLE_ROW_CLASSES

DIV_TABLE_CELL_CLASSES

public static final DataKey<String[]> DIV_TABLE_CELL_CLASSES

ADD_TRAILING_EOL

public static final DataKey<Boolean> ADD_TRAILING_EOL

SKIP_HEADING_1

public static final DataKey<Boolean> SKIP_HEADING_1

SKIP_HEADING_2

public static final DataKey<Boolean> SKIP_HEADING_2

SKIP_HEADING_3

public static final DataKey<Boolean> SKIP_HEADING_3

SKIP_HEADING_4

public static final DataKey<Boolean> SKIP_HEADING_4

SKIP_HEADING_5

public static final DataKey<Boolean> SKIP_HEADING_5

SKIP_HEADING_6

public static final DataKey<Boolean> SKIP_HEADING_6

SKIP_ATTRIBUTES

public static final DataKey<Boolean> SKIP_ATTRIBUTES

SKIP_FENCED_CODE

public static final DataKey<Boolean> SKIP_FENCED_CODE

SKIP_CHAR_ESCAPE

public static final DataKey<Boolean> SKIP_CHAR_ESCAPE

EXT_INLINE_STRONG

public static final DataKey<ExtensionConversion> EXT_INLINE_STRONG

EXT_INLINE_EMPHASIS

public static final DataKey<ExtensionConversion> EXT_INLINE_EMPHASIS

EXT_INLINE_CODE

public static final DataKey<ExtensionConversion> EXT_INLINE_CODE

EXT_INLINE_DEL

public static final DataKey<ExtensionConversion> EXT_INLINE_DEL

EXT_INLINE_INS

public static final DataKey<ExtensionConversion> EXT_INLINE_INS

EXT_INLINE_SUB

public static final DataKey<ExtensionConversion> EXT_INLINE_SUB

EXT_INLINE_SUP

public static final DataKey<ExtensionConversion> EXT_INLINE_SUP

EXT_MATH

public static final DataKey<ExtensionConversion> EXT_MATH

EXT_TABLES

public static final DataKey<ExtensionConversion> EXT_TABLES

EXT_INLINE_LINK

public static final DataKey<LinkConversion> EXT_INLINE_LINK

EXT_INLINE_IMAGE

public static final DataKey<LinkConversion> EXT_INLINE_IMAGE

FOR_DOCUMENT

public static final DataKey<Ref<Document>> FOR_DOCUMENT

TYPOGRAPHIC_REPLACEMENT_MAP

public static final DataKey<Map<String,String>> TYPOGRAPHIC_REPLACEMENT_MAP

DUMP_HTML_TREE

public static final DataKey<Boolean> DUMP_HTML_TREE

if true then will dump HTML tree of body element to console when using convert(String, Appendable)(String)

IGNORE_TABLE_HEADING_AFTER_ROWS

public static final DataKey<Boolean> IGNORE_TABLE_HEADING_AFTER_ROWS

If true then will ignore rows with th columns after rows with td columns have been emitted to the table.

If false then will convert these to regular columns.

A_NODE

public static final String A_NODE

See Also:

• Constant Field Values

ABBR_NODE

public static final String ABBR_NODE

See Also:

• Constant Field Values

ASIDE_NODE

public static final String ASIDE_NODE

See Also:

• Constant Field Values

BR_NODE

public static final String BR_NODE

See Also:

• Constant Field Values

BLOCKQUOTE_NODE

public static final String BLOCKQUOTE_NODE

See Also:

• Constant Field Values

CODE_NODE

public static final String CODE_NODE

See Also:

• Constant Field Values

IMG_NODE

public static final String IMG_NODE

See Also:

• Constant Field Values

DEL_NODE

public static final String DEL_NODE

See Also:

• Constant Field Values

STRIKE_NODE

public static final String STRIKE_NODE

See Also:

• Constant Field Values

DIV_NODE

public static final String DIV_NODE

See Also:

• Constant Field Values

DD_NODE

public static final String DD_NODE

See Also:

• Constant Field Values

DL_NODE

public static final String DL_NODE

See Also:

• Constant Field Values

DT_NODE

public static final String DT_NODE

See Also:

• Constant Field Values

I_NODE

public static final String I_NODE

See Also:

• Constant Field Values

EM_NODE

public static final String EM_NODE

See Also:

• Constant Field Values

B_NODE

public static final String B_NODE

See Also:

• Constant Field Values

STRONG_NODE

public static final String STRONG_NODE

See Also:

• Constant Field Values

EMOJI_NODE

public static final String EMOJI_NODE

See Also:

• Constant Field Values

INPUT_NODE

public static final String INPUT_NODE

See Also:

• Constant Field Values

INS_NODE

public static final String INS_NODE

See Also:

• Constant Field Values

U_NODE

public static final String U_NODE

See Also:

• Constant Field Values

SUB_NODE

public static final String SUB_NODE

See Also:

• Constant Field Values

SUP_NODE

public static final String SUP_NODE

See Also:

• Constant Field Values

HR_NODE

public static final String HR_NODE

See Also:

• Constant Field Values

OL_NODE

public static final String OL_NODE

See Also:

• Constant Field Values

UL_NODE

public static final String UL_NODE

See Also:

• Constant Field Values

LI_NODE

public static final String LI_NODE

See Also:

• Constant Field Values

TABLE_NODE

public static final String TABLE_NODE

See Also:

• Constant Field Values

TBODY_NODE

public static final String TBODY_NODE

See Also:

• Constant Field Values

TD_NODE

public static final String TD_NODE

See Also:

• Constant Field Values

TH_NODE

public static final String TH_NODE

See Also:

• Constant Field Values

THEAD_NODE

public static final String THEAD_NODE

See Also:

• Constant Field Values

TR_NODE

public static final String TR_NODE

See Also:

• Constant Field Values

CAPTION_NODE

public static final String CAPTION_NODE

See Also:

• Constant Field Values

SVG_NODE

public static final String SVG_NODE

See Also:

• Constant Field Values

P_NODE

public static final String P_NODE

See Also:

• Constant Field Values

PRE_NODE

public static final String PRE_NODE

See Also:

• Constant Field Values

MATH_NODE

public static final String MATH_NODE

See Also:

• Constant Field Values

SPAN_NODE

public static final String SPAN_NODE

See Also:

• Constant Field Values

TEXT_NODE

public static final String TEXT_NODE

See Also:

• Constant Field Values

COMMENT_NODE

public static final String COMMENT_NODE

See Also:

• Constant Field Values

H1_NODE

public static final String H1_NODE

See Also:

• Constant Field Values

H2_NODE

public static final String H2_NODE

See Also:

• Constant Field Values

H3_NODE

public static final String H3_NODE

See Also:

• Constant Field Values

H4_NODE

public static final String H4_NODE

See Also:

• Constant Field Values

H5_NODE

public static final String H5_NODE

See Also:

• Constant Field Values

H6_NODE

public static final String H6_NODE

See Also:

• Constant Field Values

DEFAULT_NODE

public static final String DEFAULT_NODE

See Also:

• Constant Field Values

HEADING_NODES

public static final String[] HEADING_NODES

EXPLICIT_LINK_TEXT_TAGS

public static String[] EXPLICIT_LINK_TEXT_TAGS

TABLE_CELL_ALIGNMENTS

private static final Map<Object, CellAlignment> TABLE_CELL_ALIGNMENTS

SPECIAL_CHARS_MAP

static final Map<String,String> SPECIAL_CHARS_MAP

TYPOGRAPHIC_QUOTES_PIPED

private static final String TYPOGRAPHIC_QUOTES_PIPED

See Also:

• Constant Field Values

TYPOGRAPHIC_SMARTS_PIPED

private static final String TYPOGRAPHIC_SMARTS_PIPED

See Also:

• Constant Field Values

TABLE_CELL_ALIGNMENT_MAP

public static final DataKey<Map<Object, CellAlignment>> TABLE_CELL_ALIGNMENT_MAP

htmlConverterOptions

final HtmlConverterOptions htmlConverterOptions

options

private final DataHolder options

nodeRendererFactories

final List<DelegatingNodeRendererFactoryWrapper> nodeRendererFactories

linkResolverFactories

final List<HtmlLinkResolverFactory> linkResolverFactories

NULL_ITERATOR

private static final Iterator<org.jsoup.nodes.Node> NULL_ITERATOR

NULL_ITERABLE

public static final Iterable<org.jsoup.nodes.Node> NULL_ITERABLE

Constructor Details

FlexmarkHtmlConverter

FlexmarkHtmlConverter(FlexmarkHtmlConverter.Builder builder)

Method Details

getOptions

public DataHolder getOptions()

builder

public static FlexmarkHtmlConverter.Builder builder()

Create a new builder for configuring an FlexmarkHtmlConverter.

Returns:

a builder

builder

public static FlexmarkHtmlConverter.Builder builder(DataHolder options)

Create a new builder for configuring an FlexmarkHtmlConverter.

Parameters:

options - initialization options

Returns:

a builder

convert

public void convert(@NotNull
 @NotNull String html,
 @NotNull
 @NotNull Appendable output)

Render a node to the appendable

Parameters:

html - html to convert to markdown

output - appendable to use for the output

convert

public String convert(@NotNull
 @NotNull String html)

Parse HTML with default options

Parameters:

html - html to be parsed

Returns:

resulting markdown string

convert

public String convert(@NotNull
 @NotNull String html,
 int maxTrailingBlankLines)

Parse HTML with given options and max trailing blank lines

Parameters:

html - html to be parsed

maxTrailingBlankLines - max trailing blank lines, -1 will suppress trailing EOL

Returns:

resulting markdown string

dumpHtmlTree

public static void dumpHtmlTree(LineAppendable out,
 org.jsoup.nodes.Node node)

convert

public void convert(org.jsoup.nodes.Node node,
 Appendable output,
 int maxTrailingBlankLines)

Render a node to the appendable

Parameters:

node - node to render

output - appendable to use for the output

maxTrailingBlankLines - max blank lines allowed at end of output

convert

public String convert(org.jsoup.nodes.Node node)

Render the tree of nodes to markdown

Parameters:

node - the root node

Returns:

the formatted markdown

processTextNodes

static void processTextNodes(@NotNull
 @NotNull HtmlNodeConverterContext context,
 @NotNull
 @NotNull org.jsoup.nodes.Node node,
 boolean stripIdAttribute,
 @Nullable
 @Nullable CharSequence textPrefix,
 @Nullable
 @Nullable CharSequence textSuffix)

wrapTextNodes

static void wrapTextNodes(@NotNull
 @NotNull HtmlNodeConverterContext context,
 @NotNull
 @NotNull org.jsoup.nodes.Node node,
 @NotNull
 @NotNull CharSequence wrapText,
 boolean needSpaceAround)

processConditional

static void processConditional(@NotNull
 @NotNull HtmlNodeConverterContext context,
 @NotNull
 @NotNull ExtensionConversion extensionConversion,
 @NotNull
 @NotNull org.jsoup.nodes.Node node,
 @NotNull
 @NotNull Runnable processNode)

appendOuterHtml

static void appendOuterHtml(@NotNull
 @NotNull HtmlNodeConverterSubContext context,
 @NotNull
 @NotNull org.jsoup.nodes.Node node)

processWrapped

public static void processWrapped(@NotNull
 @NotNull HtmlNodeConverterSubContext context,
 @NotNull
 @NotNull org.jsoup.nodes.Node node,
 @Nullable
 @Nullable Boolean isBlock,
 boolean escapeMarkdown)

processHtmlTree

static void processHtmlTree(@NotNull
 @NotNull HtmlNodeConverterSubContext context,
 @NotNull
 @NotNull org.jsoup.nodes.Node parent,
 boolean outputAttributes,
 @Nullable
 @Nullable Runnable prePopAction)

dumpState

static String dumpState(@NotNull
 @NotNull HtmlNodeConverterContext context)

processDefault

static void processDefault(@NotNull
 @NotNull HtmlNodeConverterSubContext subContext,
 @NotNull
 @NotNull org.jsoup.nodes.Node node,
 boolean outputUnknownTags)