mistletoe.html_renderer.HTMLRenderer

class documentation

class HTMLRenderer(BaseRenderer): (source)

Known subclasses: mistletoe.contrib.github_wiki.GithubWikiRenderer, mistletoe.contrib.mathjax.MathJaxRenderer, mistletoe.contrib.toc_renderer.TOCRenderer

View In Hierarchy

HTML renderer class.

See mistletoe.base_renderer module for more info.

Static Method	`escape_html`	This method is deprecated. Use `html.escape` instead.
Static Method	`escape_url`	Escape urls to prevent code injection craziness. (Hopefully.)
Static Method	`render_html_block`	Undocumented
Static Method	`render_html_span`	Undocumented
Static Method	`render_line_break`	Undocumented
Static Method	`render_thematic_break`	Undocumented
Method	`__exit__`	Make renderer classes into context managers.
Method	`__init__`	No summary
Method	`render_auto_link`	Undocumented
Method	`render_block_code`	Undocumented
Method	`render_document`	Undocumented
Method	`render_emphasis`	Undocumented
Method	`render_escape_sequence`	Undocumented
Method	`render_heading`	Undocumented
Method	`render_image`	Undocumented
Method	`render_inline_code`	Undocumented
Method	`render_link`	Undocumented
Method	`render_list`	Undocumented
Method	`render_list_item`	Undocumented
Method	`render_paragraph`	Undocumented
Method	`render_quote`	Undocumented
Method	`render_raw_text`	Default render method for RawText. Simply return token.content.
Method	`render_strikethrough`	Undocumented
Method	`render_strong`	Undocumented
Method	`render_table`	Undocumented
Method	`render_table_cell`	Undocumented
Method	`render_table_row`	Undocumented
Method	`render_to_plain`	Undocumented
Instance Variable	`_suppress_ptag_stack`	Undocumented

Inherited from BaseRenderer:

Method	`__enter__`	Make renderer classes into context managers.
Method	`render`	Grabs the class name from input token and finds its corresponding render function.
Method	`render_inner`	Recursively renders child tokens. Joins the rendered strings with no space in between.
Instance Variable	`footnotes`	Undocumented
Instance Variable	`render_map`	maps tokens to their corresponding render functions.
Class Method	`_cls_to_func`	Undocumented
Static Method	`_tokens_from_module`	Helper method; takes a module and returns a list of all token classes specified in module.__all__. Useful when custom tokens are defined in a separate module.
Class Variable	`_parse_name`	Undocumented
Instance Variable	`_extras`	a list of custom tokens to be added to the parsing process.

@staticmethod
def escape_html(raw: str) -> str: (source) ¶

This method is deprecated. Use html.escape instead.

@staticmethod
def escape_url(raw: str) -> str: (source) ¶

Escape urls to prevent code injection craziness. (Hopefully.)

@staticmethod
def render_html_block(token: block_token.HTMLBlock) -> str: (source) ¶

Undocumented

@staticmethod
def render_html_span(token: span_token.HTMLSpan) -> str: (source) ¶

Undocumented

@staticmethod
def render_line_break(token: span_token.LineBreak) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_line_break

Undocumented

@staticmethod
def render_thematic_break(token: block_token.ThematicBreak) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_thematic_break

Undocumented

def __exit__(self, *args): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.__exit__

Make renderer classes into context managers.

Reset block_token._token_types and span_token._token_types.

def __init__(self, *extras): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.__init__

overridden in mistletoe.contrib.github_wiki.GithubWikiRenderer, mistletoe.contrib.toc_renderer.TOCRenderer

Parameters
*extras:`list`	allows subclasses to add even more custom tokens.

def render_auto_link(self, token: span_token.AutoLink) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_auto_link

Undocumented

def render_block_code(self, token: block_token.BlockCode) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_block_code

Undocumented

def render_document(self, token: block_token.Document) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_document

overridden in mistletoe.contrib.mathjax.MathJaxRenderer

Undocumented

def render_emphasis(self, token: span_token.Emphasis) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_emphasis

Undocumented

def render_escape_sequence(self, token: span_token.EscapeSequence) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_escape_sequence

Undocumented

def render_heading(self, token: block_token.Heading) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_heading

overridden in mistletoe.contrib.toc_renderer.TOCRenderer

Undocumented

def render_image(self, token: span_token.Image) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_image

Undocumented

def render_inline_code(self, token: span_token.InlineCode) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_inline_code

Undocumented

def render_link(self, token: span_token.Link) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_link

Undocumented

def render_list(self, token: block_token.List) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_list

Undocumented

def render_list_item(self, token: block_token.ListItem) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_list_item

Undocumented

def render_paragraph(self, token: block_token.Paragraph) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_paragraph

Undocumented

def render_quote(self, token: block_token.Quote) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_quote

Undocumented

def render_raw_text(self, token: span_token.RawText) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_raw_text

Default render method for RawText. Simply return token.content.

def render_strikethrough(self, token: span_token.Strikethrough) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_strikethrough

Undocumented

def render_strong(self, token: span_token.Strong) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_strong

Undocumented

def render_table(self, token: block_token.Table) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_table

Undocumented

def render_table_cell(self, token: block_token.TableCell, in_header=False) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_table_cell

Undocumented

def render_table_row(self, token: block_token.TableRow, is_header=False) -> str: (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_table_row

Undocumented

def render_to_plain(self, token) -> str: (source) ¶

Undocumented

_suppress_ptag_stack: list[bool] = (source) ¶

Undocumented