class markdown::HtmlRendererBuilder

sys::Obj
  markdown::HtmlRendererBuilder

@Js

Source

Builder for configuring an HtmlRenderer.

attrProviderFactory

This attrProviderFactory(|HtmlContext->AttrProvider| factory)

Source

Add a factory for an attribute provider for adding/changing HTML attributes to the rendered tags.

build

HtmlRenderer build()

Source

Get the configured HtmlRenderer

extensions

This extensions(MarkdownExt[] exts)

Source

Configure the given extensions on this this renderer

nodeRendererFactory

This nodeRendererFactory(|HtmlContext->NodeRenderer| factory)

Source

Add a factory for instantiating a node renderer (done when rendering). This allows to override the rendering of node types or define rendering for custom node types.

If multiple node renderers for the same node type are created, the one from the factory that was added first "wins". (This is how rendering for core node types can be overriden; the default rendering comes last).

withEscapeHtml

This withEscapeHtml(Bool val := true)

Source

Whether HtmlInline and HtmlBlock should be escaped, defaults to false.

Note that HtmlInline is only a tag itself, not the text between an opening tag and closing tag. So markup in the text will be parsed as normal and is not affected by this option.

withOmitSingleParagraphP

This withOmitSingleParagraphP(Bool val := true)

Source

Whether documents that only contain a single paragraph shoudl be rendered without the <p> tag. Set to true to render without the tag; the default of false always renders the tag.

withPercentEncodeUrls

This withPercentEncodeUrls(Bool val := true)

Source

Whether URLs of link or images should be percent-encoded, defaults to false.

If enabled, the following is done:

• Existing percent-encoded parts are preserved (e.g. "%20" is kept as "%20")
• Reserved characters such as "/" are preserved, except for "[" and "]" (see encodeURL in JS).
• Other characters such as umlauts are percent-encoded

withSanitizeUrls

This withSanitizeUrls(Bool val := true)

Source

Whether Image src and Link href should be sanitized, defaults to false.

withSoftBreak

This withSoftBreak(Str s)

Source

The HTML to use for rendering a softbreak, default to \n (meaning the rendered result doesn't have a line break).

Set it to <br> or <br /> to make the hard breaks.

Set it to (space) to ingore line wrapping in the source.