markdown.extensions.Extension

class documentation

class Extension: (source)

View In Hierarchy

Base class for extensions to subclass.

Method	`__init__`	Initiate Extension and set up configs.
Method	`extendMarkdown`	Add the various processors and patterns to the Markdown Instance.
Method	`getConfig`	Return a setting for the given key or an empty string.
Method	`getConfigInfo`	Return all config descriptions as a list of tuples.
Method	`getConfigs`	Return all configs settings as a dict.
Method	`setConfig`	Set a config setting for `key` with the given `value`.
Method	`setConfigs`	Set multiple config settings given a dict or list of tuples.
Class Variable	`config`	Undocumented

def __init__(self, **kwargs): (source)

overridden in markdown.extensions.codehilite.CodeHiliteExtension, markdown.extensions.extra.ExtraExtension, markdown.extensions.fenced_code.FencedCodeExtension, markdown.extensions.footnotes.FootnoteExtension, markdown.extensions.smarty.SmartyExtension, markdown.extensions.tables.TableExtension, markdown.extensions.toc.TocExtension, markdown.extensions.wikilinks.WikiLinkExtension

Initiate Extension and set up configs.

def extendMarkdown(self, md): (source)

overridden in markdown.extensions.abbr.AbbrExtension, markdown.extensions.admonition.AdmonitionExtension, markdown.extensions.attr_list.AttrListExtension, markdown.extensions.codehilite.CodeHiliteExtension, markdown.extensions.def_list.DefListExtension, markdown.extensions.extra.ExtraExtension, markdown.extensions.fenced_code.FencedCodeExtension, markdown.extensions.footnotes.FootnoteExtension, markdown.extensions.legacy_attrs.LegacyAttrExtension, markdown.extensions.legacy_em.LegacyEmExtension, markdown.extensions.md_in_html.MarkdownInHtmlExtension, markdown.extensions.meta.MetaExtension, markdown.extensions.nl2br.Nl2BrExtension, markdown.extensions.sane_lists.SaneListExtension, markdown.extensions.smarty.SmartyExtension, markdown.extensions.tables.TableExtension, markdown.extensions.toc.TocExtension, markdown.extensions.wikilinks.WikiLinkExtension

Add the various processors and patterns to the Markdown Instance. This method must be overridden by every extension. Keyword arguments: * md: The Markdown instance.

def getConfig(self, key, default=''): (source)

Return a setting for the given key or an empty string.

def getConfigInfo(self): (source)

Return all config descriptions as a list of tuples.

def getConfigs(self): (source)

Return all configs settings as a dict.

def setConfig(self, key, value): (source)

Set a config setting for `key` with the given `value`.

def setConfigs(self, items): (source)

Set multiple config settings given a dict or list of tuples.

config: dict = (source)

Undocumented