Top Description Inners Fields Constructors Methods
com.vladsch.flexmark.html2md.converter

public Class FlexmarkHtmlConverter

extends Object
Class Inheritance
Annotations
@SuppressWarnings:WeakerAccess
Imports
com.vladsch.flexmark.ast.Reference, com.vladsch.flexmark.html.renderer.HeaderIdGeneratorFactory, .LinkStatus, .LinkType, .ResolvedLink, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.builder.BuilderBase, com.vladsch.flexmark.util.data.DataHolder, .DataKey, .MutableDataHolder, .ScopedDataSet, com.vladsch.flexmark.util.dependency.DependencyResolver, com.vladsch.flexmark.util.format.TableFormatOptions, com.vladsch.flexmark.util.format.options.TableCaptionHandling, com.vladsch.flexmark.util.html.Attribute, .Attributes, .CellAlignment, .MutableAttributes, com.vladsch.flexmark.util.misc.Extension, .Ref, com.vladsch.flexmark.util.sequence.BasedSequence, .LineAppendable, .LineAppendableImpl, com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder, .StringSequenceBuilder, org.jetbrains.annotations.NotNull, .Nullable, org.jsoup.Jsoup, org.jsoup.nodes.Document, .Element, .Node, .TextNode, java.util.*, java.util.function.BiFunction, java.util.regex.Matcher, .Pattern
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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
FlexmarkHtmlConverter.Builder

Builder for configuring an FlexmarkHtmlConverter.

public static interface
FlexmarkHtmlConverter.HtmlConverterExtension

Extension for FlexmarkHtmlConverter.

private class
FlexmarkHtmlConverter.MainHtmlConverter

Field Summary

Modifier and TypeField and Description
public static final String
A_NODE

public static final String
ABBR_NODE

public static final DataKey<Boolean>
ADD_TRAILING_EOL

public static final String
ASIDE_NODE

public static final String
B_NODE

public static final String
BLOCKQUOTE_NODE

public static final DataKey<Boolean>
BR_AS_EXTRA_BLANK_LINES

public static final DataKey<Boolean>
BR_AS_PARA_BREAKS

public static final String
BR_NODE

public static final String
CAPTION_NODE

public static final DataKey<String>
CODE_INDENT

public static final String
CODE_NODE

public static final String
COMMENT_NODE

public static final DataKey<Boolean>
COMMENT_ORIGINAL_NON_NUMERIC_LIST_ITEM

public static final String
DD_NODE

public static final String
DEFAULT_NODE

public static final DataKey<Integer>
DEFINITION_MARKER_SPACES

public static final String
DEL_NODE

public static final DataKey<Boolean>
DIV_AS_PARAGRAPH

public static final String
DIV_NODE

public static final DataKey<String[]>
DIV_TABLE_CELL_CLASSES

public static final DataKey<String[]>
DIV_TABLE_HDR_CLASSES

public static final DataKey<Boolean>
DIV_TABLE_PROCESSING

public static final DataKey<String[]>
DIV_TABLE_ROW_CLASSES

public static final String
DL_NODE

public static final DataKey<Boolean>
DOT_ONLY_NUMERIC_LISTS

public static final String
DT_NODE

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)

public static final String
EM_NODE

public static final String
EMOJI_NODE

public static final DataKey<String>
EOL_IN_TITLE_ATTRIBUTE

public static String[]
EXPLICIT_LINK_TEXT_TAGS

public static final DataKey<ExtensionConversion>
EXT_INLINE_CODE

public static final DataKey<ExtensionConversion>
EXT_INLINE_DEL

public static final DataKey<ExtensionConversion>
EXT_INLINE_EMPHASIS

public static final DataKey<LinkConversion>
EXT_INLINE_IMAGE

public static final DataKey<ExtensionConversion>
EXT_INLINE_INS

public static final DataKey<LinkConversion>
EXT_INLINE_LINK

public static final DataKey<ExtensionConversion>
EXT_INLINE_STRONG

public static final DataKey<ExtensionConversion>
EXT_INLINE_SUB

public static final DataKey<ExtensionConversion>
EXT_INLINE_SUP

public static final DataKey<ExtensionConversion>
EXT_MATH

public static final DataKey<ExtensionConversion>
EXT_TABLES

public static final DataKey<Boolean>
EXTRACT_AUTO_LINKS

public static final DataKey<Ref<Document>>
FOR_DOCUMENT

public static final DataKey<Integer>
FORMAT_FLAGS

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

public static final String
H1_NODE

public static final String
H2_NODE

public static final String
H3_NODE

public static final String
H4_NODE

public static final String
H5_NODE

public static final String
H6_NODE

public static final String[]
HEADING_NODES

public static final String
HR_NODE

pack-priv final HtmlConverterOptions
htmlConverterOptions

public static final String
I_NODE

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.

public static final String
IMG_NODE

public static final String
INPUT_NODE

public static final String
INS_NODE

public static final String
LI_NODE

pack-priv final List<HtmlLinkResolverFactory>
linkResolverFactories

public static final DataKey<Boolean>
LIST_CONTENT_INDENT

public static final DataKey<Integer>
LIST_ITEM_INDENT

public static final DataKey<Boolean>
LISTS_END_ON_DOUBLE_BLANK

public static final String
MATH_NODE

public static final DataKey<Integer>
MAX_BLANK_LINES

public static final DataKey<Integer>
MAX_TRAILING_BLANK_LINES

public static final DataKey<Integer>
MIN_SETEXT_HEADING_MARKER_LENGTH

public static final DataKey<String>
NBSP_TEXT

pack-priv final List<DelegatingNodeRendererFactoryWrapper>
nodeRendererFactories

public static final Iterable<Node>
NULL_ITERABLE

private static final Iterator<Node>
NULL_ITERATOR

public static final String
OL_NODE

private final DataHolder
options

public static final DataKey<Character>
ORDERED_LIST_DELIMITER

public static final DataKey<Boolean>
OUTPUT_ATTRIBUTES_ID

public static final DataKey<String>
OUTPUT_ATTRIBUTES_NAMES_REGEX

public static final DataKey<String>
OUTPUT_ID_ATTRIBUTE_REGEX

public static final DataKey<Boolean>
OUTPUT_UNKNOWN_TAGS

public static final String
P_NODE

public static final DataKey<Boolean>
PRE_CODE_PRESERVE_EMPHASIS

public static final String
PRE_NODE

public static final DataKey<Boolean>
RENDER_COMMENTS

public static final DataKey<Boolean>
SETEXT_HEADINGS

public static final DataKey<Boolean>
SKIP_ATTRIBUTES

public static final DataKey<Boolean>
SKIP_CHAR_ESCAPE

public static final DataKey<Boolean>
SKIP_FENCED_CODE

public static final DataKey<Boolean>
SKIP_HEADING_1

public static final DataKey<Boolean>
SKIP_HEADING_2

public static final DataKey<Boolean>
SKIP_HEADING_3

public static final DataKey<Boolean>
SKIP_HEADING_4

public static final DataKey<Boolean>
SKIP_HEADING_5

public static final DataKey<Boolean>
SKIP_HEADING_6

public static final String
SPAN_NODE

pack-priv static final Map<String, String>
SPECIAL_CHARS_MAP

public static final String
STRIKE_NODE

public static final String
STRONG_NODE

public static final String
SUB_NODE

public static final String
SUP_NODE

public static final String
SVG_NODE

public static final DataKey<TableCaptionHandling>
TABLE_CAPTION

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

private static final Map<Object, CellAlignment>
TABLE_CELL_ALIGNMENTS

public static final DataKey<Boolean>
TABLE_LEAD_TRAIL_PIPES

Deprecated
public static final DataKey<Integer>
TABLE_MIN_SEPARATOR_COLUMN_WIDTH

Deprecated
public static final DataKey<Integer>
TABLE_MIN_SEPARATOR_DASHES

Deprecated
public static final String
TABLE_NODE

public static final DataKey<Boolean>
TABLE_SPACE_AROUND_PIPES

Deprecated
public static final String
TBODY_NODE

public static final String
TD_NODE

public static final String
TEXT_NODE

public static final String
TH_NODE

public static final String
THEAD_NODE

public static final DataKey<String>
THEMATIC_BREAK

public static final String
TR_NODE

public static final DataKey<Boolean>
TYPOGRAPHIC_QUOTES

private static final String
TYPOGRAPHIC_QUOTES_PIPED

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

public static final DataKey<Boolean>
TYPOGRAPHIC_SMARTS

private static final String
TYPOGRAPHIC_SMARTS_PIPED

public static final String
U_NODE

public static final String
UL_NODE

public static final DataKey<Character>
UNORDERED_LIST_DELIMITER

public static final DataKey<String[]>
UNWRAPPED_TAGS

public static final DataKey<Boolean>
WRAP_AUTO_LINKS

public static final DataKey<String[]>
WRAPPED_TAGS

Constructor Summary

AccessConstructor and Description
pack-priv
FlexmarkHtmlConverter(FlexmarkHtmlConverter.Builder builder)

Method Summary

Modifier and TypeMethod and Description
pack-priv static void
appendOuterHtml(@NotNull HtmlNodeConverterSubContext context, @NotNull Node node)

public static FlexmarkHtmlConverter.Builder

Returns:

a builder
builder()

Create a new builder for configuring an FlexmarkHtmlConverter.

public static FlexmarkHtmlConverter.Builder

Returns:

a builder
builder(DataHolder
initialization options
options)

Create a new builder for configuring an FlexmarkHtmlConverter.

public void
convert(@NotNull String
html to convert to markdown
html, @NotNull Appendable
appendable to use for the output
output)

Render a node to the appendable

public String

Returns:

resulting markdown string
convert(@NotNull String
html to be parsed
html)

Parse HTML with default options

public String

Returns:

resulting markdown string
convert(@NotNull String
html to be parsed
html, int
max trailing blank lines, -1 will suppress trailing EOL
maxTrailingBlankLines)

Parse HTML with given options and max trailing blank lines

public void
convert(Node
node to render
node, Appendable
appendable to use for the output
output, int
max blank lines allowed at end of output
maxTrailingBlankLines)

Render a node to the appendable

public String

Returns:

the formatted markdown
convert(Node
the root node
node)

Render the tree of nodes to markdown

public static void
dumpHtmlTree(LineAppendable out, Node node)

pack-priv static String
dumpState(@NotNull HtmlNodeConverterContext context)

public DataHolder
getOptions()

pack-priv static void
processConditional(@NotNull HtmlNodeConverterContext context, @NotNull ExtensionConversion extensionConversion, @NotNull Node node, @NotNull Runnable processNode)

pack-priv static void
processDefault(@NotNull HtmlNodeConverterSubContext subContext, @NotNull Node node, boolean outputUnknownTags)

pack-priv static void
processHtmlTree(@NotNull HtmlNodeConverterSubContext context, @NotNull Node parent, boolean outputAttributes, @Nullable Runnable prePopAction)

pack-priv static void
processTextNodes(@NotNull HtmlNodeConverterContext context, @NotNull Node node, boolean stripIdAttribute, @Nullable CharSequence textPrefix, @Nullable CharSequence textSuffix)

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

pack-priv static void
wrapTextNodes(@NotNull HtmlNodeConverterContext context, @NotNull Node node, @NotNull CharSequence wrapText, boolean needSpaceAround)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait