mistletoe.renderers.base.
BaseRenderer
Bases: object
object
Base class for renderers.
All renderers should …
define all render functions specified in self.render_map;
be a context manager (by inheriting __enter__ and __exit__);
Custom renderers could …
set the default tokens searched for during parsing, by overriding default_block_tokens and/or default_span_tokens
default_block_tokens
default_span_tokens
add additional render functions by appending to self.render_map;
Suppose SomeRenderer inherits BaseRenderer, and fin is the input file. The syntax looks something like this:
fin
>>> from mistletoe import Document >>> from some_renderer import SomeRenderer >>> with SomeRenderer() as renderer: ... rendered = renderer.render(Document.read(fin))
See mistletoe.renderers.html for an implementation example.
The keys of self.render_map should exactly match the class name of tokens;
Render function names should be of form: render_ + the “snake-case” form of token’s class name.
render_map (dict) – maps tokens to their corresponding render functions.
__enter__
Make renderer classes into context managers, reinstatiated the originally instatiated parse_context.
parse_context
__exit__
Make renderer classes into context managers.
__init__
Initialise the renderer.
parse_context (mistletoe.parse_context.ParseContext) – the parse context stores global parsing variables, such as the block/span tokens to search for, and link/footnote definitions that have been collected. If None, a new context will be instatiated, with the default block/span tokens for this renderer. These will be re-instatiated on __enter__.
mistletoe.renderers.html.
HTMLRenderer
Bases: mistletoe.renderers.base.BaseRenderer
mistletoe.renderers.base.BaseRenderer
HTML renderer class.
Initialise the renderer
as_standalone – return the HTML body within a minmal HTML page
add_css – if as_standalone=True, CSS to add to the header
mistletoe.renderers.json.
JsonRenderer
mistletoe.renderers.latex.
LaTeXRenderer