MarkdownGfmMdToHtml
class
This is a helper class used by the Markdown feature to convert Markdown to HTML.
Properties
_processor : Processor<undefined, undefined, undefined, undefined, undefined>privatemodule:markdown-gfm/markdown2html/markdown2html~MarkdownGfmMdToHtml#_processor
Methods
constructor( options = { [options.plugins] } )module:markdown-gfm/markdown2html/markdown2html~MarkdownGfmMdToHtml#constructorCreates a new instance of MarkdownGfmMdToHtml.
Parameters
options : objectThe options for the MarkdownGfmMdToHtml instance.
Properties[ options.plugins ] : Record<string, Pluggable>The plugins to be used by the
unified().use()processor for converting Markdown to HTML. By default,MarkdownGfmMdToHtmlDefaultPluginsis used. You can override the defaults by passing your own plugins.Learn more about the
unified()plugin chain in the unified documentation.Defaults to
MarkdownGfmMdToHtmlDefaultPlugins
Defaults to
{}
parse( markdown ) → stringmodule:markdown-gfm/markdown2html/markdown2html~MarkdownGfmMdToHtml#parse