MarkdownGfmDataProcessor
This data processor implementation uses GitHub Flavored Markdown as input/output data.
See the Markdown output guide to learn more on how to enable it.
Properties
-
_html2markdown : MarkdownGfmHtmlToMdprivatemodule:markdown-gfm/gfmdataprocessor~MarkdownGfmDataProcessor#_html2markdownHelper for converting HTML to Markdown.
-
_htmlDP : HtmlDataProcessorprivatemodule:markdown-gfm/gfmdataprocessor~MarkdownGfmDataProcessor#_htmlDPHTML data processor used to process HTML produced by the Markdown-to-HTML converter and the other way.
-
_markdown2html : MarkdownGfmMdToHtmlprivatemodule:markdown-gfm/gfmdataprocessor~MarkdownGfmDataProcessor#_markdown2htmlHelper for converting Markdown to HTML.
Methods
-
constructor( document )module:markdown-gfm/gfmdataprocessor~MarkdownGfmDataProcessor#constructor -
keepHtml( element ) → voidmodule:markdown-gfm/gfmdataprocessor~MarkdownGfmDataProcessor#keepHtmlKeeps the specified element in the output as HTML. This is useful if the editor contains features producing HTML that is not a part of the Markdown standard.
By default, all HTML tags are removed.
Parameters
element : keyof HTMLElementTagNameMapThe element name to be kept.
Returns
void
-
registerRawContentMatcher( pattern ) → voidmodule:markdown-gfm/gfmdataprocessor~MarkdownGfmDataProcessor#registerRawContentMatcherRegisters a
MatcherPatternfor view elements whose content should be treated as raw data and not processed during the conversion from Markdown to view elements.The raw data can be later accessed by a custom property of a view element called
"$rawContent".Parameters
pattern : MatcherPatternThe pattern matching all view elements whose content should be treated as raw data.
Returns
void
-
toData( viewFragment ) → stringmodule:markdown-gfm/gfmdataprocessor~MarkdownGfmDataProcessor#toDataConverts the provided
ViewDocumentFragmentto data format – in this case to a Markdown string.Parameters
viewFragment : ViewDocumentFragment
Returns
stringMarkdown string.
-
toView( data ) → ViewDocumentFragmentmodule:markdown-gfm/gfmdataprocessor~MarkdownGfmDataProcessor#toViewConverts the provided Markdown string to a view tree.
Parameters
data : stringA Markdown string.
Returns
ViewDocumentFragmentThe converted view element.
-
useFillerType() → voidmodule:markdown-gfm/gfmdataprocessor~MarkdownGfmDataProcessor#useFillerTypeThis method does not have any effect on the data processor result. It exists for compatibility with the
DataProcessorinterface.Returns
void