diff --git a/modules/web/doc_classes/MarkdownRenderer.xml b/modules/web/doc_classes/MarkdownRenderer.xml index faef1b747..0d0157f84 100644 --- a/modules/web/doc_classes/MarkdownRenderer.xml +++ b/modules/web/doc_classes/MarkdownRenderer.xml @@ -1,10 +1,11 @@ - Renders markdown as HTML. + Renders markdown. - Renders markdown as HTML. + Renders markdown (by defautl as HTML). + Rendering logic can be customized by overriding [member _renderer_callback] and setting [member render_type] to [member RENDERER_TYPE_CUSTOM]. @@ -13,83 +14,107 @@ + If you use RENDERER_TYPE_CUSTOM, this is the callback thay you are expected to implement. + Render a markdown document. - - - - - - + Deprecated. Use [member render] instead (it's the same). + HTML render flags to use. + Enabled markdown extensions. + Maximum nesting. + Renderer type. + Toc level. + Whether to use smartypants or not. SmartyPants translates plain ASCII punctuation characters into “smart” typographic punctuation HTML entities. + Full html renderer. + Toc html renderer. + Custom renderer. When rendering the [member _renderer_callback] virtual method will be called for every entity. + Skip html. + Escape html. + Hard wrap html. + Use XHTML. + Tables extension. + Fenced code extension. + Footnotes extension. + Autolink extension. + Strikethrough extension. + Underline extension. + Highlight extension. + Quote extension. + Superscript extension. + Math extension. + No intra emphasis extension. + Space headers extension. + Math explicit extension. + Disable indented code extension. diff --git a/modules/web/doc_classes/MarkdownRendererCustomRendererCallback.xml b/modules/web/doc_classes/MarkdownRendererCustomRendererCallback.xml index 7fb39ac1a..7cce6d712 100644 --- a/modules/web/doc_classes/MarkdownRendererCustomRendererCallback.xml +++ b/modules/web/doc_classes/MarkdownRendererCustomRendererCallback.xml @@ -1,8 +1,10 @@ + Helper class used by [MarkdownRenderer]. + Helper class used by [MarkdownRenderer]. @@ -10,128 +12,189 @@ + Alt text. + Auto link type. + Callback type. + Content. + Display mode. + Inline render. + Lang. + Lebel. + Link. + List Flags. + Num. + Set this to send the renderer the resulting text. + Result code. Some of the [member callback_type]s use it. + Table flags. + Text. + Title. + Blockcode callback. Sets [member text], [member lang]. + Blockquote callback. Sets [member content]. + Header callback. Sets [member content], [member level]. + Hrule callback. No properties. + List callback. Sets [member content], [member flags]. + Listitem callback. Sets [member content], [member flags]. + Paragraph callback. Sets [member content]. + Table callback. Sets [member content]. + Table Header callback. Sets [member content]. + Table Body callback. Sets [member content]. + table_row callback. Sets [member content]. + Table Cell callback. Sets [member content], [member flags]. + Footnotes callback. Sets [member content]. + Footnote Def callback. Sets [member content], [member num]. + Blockhtml callback. Sets [member text]. + Autolink callback. Sets [member link], [member type]. Uses [member result_code]. If set to 0 just copies input to output. + Codespan callback. Sets [member text]. Uses [member result_code]. If set to 0 just copies input to output. + Double Emphasis callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output. + Emphasis callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output. + Underline callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output. + Highlight callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output. + Quote callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output. + Image callback. Sets [member link], [member title], [member alt]. Uses [member result_code]. If set to 0 just copies input to output. + Linebreak callback. No properties. Uses [member result_code]. If set to 0 just copies input to output. + Link callback. Sets [member content], [member link], [member title]. Uses [member result_code]. If set to 0 just copies input to output. + Triple Emphasis callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output. + Strikethrough callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output. + Superscript callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output. + Footnote Ref callback. Sets [member num]. Uses [member result_code]. If set to 0 just copies input to output. + Math callback. Sets [member text], [member displaymode]. Uses [member result_code]. If set to 0 just copies input to output. + Raw html callback. Sets [member text]. Uses [member result_code]. If set to 0 just copies input to output. + Entity callback. Sets [member text]. + Normal Text callback. Sets [member text]. + Doc Header callback. Sets [member inline_render]. + Doc Footer callback. Sets [member inline_render]. + Ordered list. + li block. + Left algin. + Right align. + Center align. + Align mask. + Header flag. + No autolink. + Normal autolink. + Email autolink.