markdown.extensions.toc.TocExtension

class documentation

class TocExtension(Extension): (source)

Undocumented

Method	`__init__`	Initiate Extension and set up configs.
Method	`extendMarkdown`	Add the various processors and patterns to the Markdown Instance.
Method	`reset`	Undocumented
Instance Variable	`config`	Undocumented
Instance Variable	`md`	Undocumented

Inherited from Extension:

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.

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

overrides markdown.extensions.Extension.__init__

Initiate Extension and set up configs.

def extendMarkdown(self, md): (source)

overrides markdown.extensions.Extension.extendMarkdown

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 reset(self): (source)

Undocumented

config = (source)

overrides markdown.extensions.Extension.config

Undocumented

md = (source)

Undocumented