markdown_it.renderer.RendererHTML Class Reference

Inheritance diagram for markdown_it.renderer.RendererHTML:

Collaboration diagram for markdown_it.renderer.RendererHTML:

Public Member Functions
	__init__ (self, Any parser=None)
str	render (self, Sequence[Token] tokens, OptionsDict options, EnvType env)
str	renderInline (self, Sequence[Token] tokens, OptionsDict options, EnvType env)
str	renderToken (self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	renderInlineAsText (self, Sequence[Token]|None tokens, OptionsDict options, EnvType env)
str	code_inline (self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	code_block (self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	fence (self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	image (self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	hardbreak (self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	softbreak (self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	text (self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	html_block (self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	html_inline (self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)

Static Public Member Functions
str	renderAttrs (Token token)

Public Attributes
	rules

Detailed Description

Contains render rules for tokens. Can be updated and extended.

Example:

Each rule is called as independent static function with fixed signature:

::

    class Renderer:
        def token_type_name(self, tokens, idx, options, env) {
            # ...
            return renderedHTML

::

    class CustomRenderer(RendererHTML):
        def strong_open(self, tokens, idx, options, env):
            return '<b>'
        def strong_close(self, tokens, idx, options, env):
            return '</b>'

    md = MarkdownIt(renderer_cls=CustomRenderer)

    result = md.render(...)

See https://github.com/markdown-it/markdown-it/blob/master/lib/renderer.js
for more details and examples.

Member Function Documentation

render()

str markdown_it.renderer.RendererHTML.render	(		self,
		Sequence[Token]	tokens,
		OptionsDict	options,
		EnvType	env
	)

Takes token stream and generates HTML.

:param tokens: list on block tokens to render
:param options: params of parser instance
:param env: additional data from parsed input

Reimplemented from markdown_it.renderer.RendererProtocol.

renderAttrs()

str markdown_it.renderer.RendererHTML.renderAttrs ( Token  token )

static

Render token attributes to string.

renderInline()

str markdown_it.renderer.RendererHTML.renderInline	(		self,
		Sequence[Token]	tokens,
		OptionsDict	options,
		EnvType	env
	)

The same as ``render``, but for single token of `inline` type.

:param tokens: list on block tokens to render
:param options: params of parser instance
:param env: additional data from parsed input (references, for example)

renderInlineAsText()

str markdown_it.renderer.RendererHTML.renderInlineAsText	(		self,
		Sequence[Token] | None	tokens,
		OptionsDict	options,
		EnvType	env
	)

Special kludge for image `alt` attributes to conform CommonMark spec.

Don't try to use it! Spec requires to show `alt` content with stripped markup,
instead of simple escaping.

:param tokens: list on block tokens to render
:param options: params of parser instance
:param env: additional data from parsed input

renderToken()

str markdown_it.renderer.RendererHTML.renderToken	(		self,
		Sequence[Token]	tokens,
		int	idx,
		OptionsDict	options,
		EnvType	env
	)

Default token renderer.

Can be overridden by custom function

:param idx: token index to render
:param options: params of parser instance

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/markdown_it/renderer.py