mdit_py_plugins.footnote.index Namespace Reference

Classes
class	_FootnoteData
class	_RefData

Functions
None	footnote_plugin (MarkdownIt md, *bool inline=True, bool move_to_end=True, bool always_match_refs=False)
_FootnoteData	_data_from_env (EnvType env)
bool	footnote_def (StateBlock state, int startLine, int endLine, bool silent)
bool	footnote_inline (StateInline state, bool silent)
bool	footnote_ref (StateInline state, bool silent, *bool always_match=False)
None	footnote_tail (StateCore state)
str	render_footnote_anchor_name (RendererProtocol self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
	Renderer partials.
str	render_footnote_caption (RendererProtocol self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	render_footnote_ref (RendererProtocol self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	render_footnote_block_open (RendererProtocol self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	render_footnote_block_close (RendererProtocol self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	render_footnote_open (RendererProtocol self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	render_footnote_close (RendererProtocol self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	render_footnote_anchor (RendererProtocol self, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)

Detailed Description

Process footnotes

Function Documentation

footnote_def()

bool mdit_py_plugins.footnote.index.footnote_def	(	StateBlock	state,
		int	startLine,
		int	endLine,
		bool	silent
	)

Process footnote block definition

footnote_inline()

bool mdit_py_plugins.footnote.index.footnote_inline	(	StateInline	state,
		bool	silent
	)

Process inline footnotes (^[...])

footnote_plugin()

None mdit_py_plugins.footnote.index.footnote_plugin	(	MarkdownIt	md,
		*bool	inline = True,
		bool	move_to_end = True,
		bool	always_match_refs = False
	)

Plugin ported from
`markdown-it-footnote <https://github.com/markdown-it/markdown-it-footnote>`__.

It is based on the
`pandoc definition <http://johnmacfarlane.net/pandoc/README.html#footnotes>`__:

.. code-block:: md

    Normal footnote:

    Here is a footnote reference,[^1] and another.[^longnote]

    [^1]: Here is the footnote.

    [^longnote]: Here's one with multiple blocks.

        Subsequent paragraphs are indented to show that they
    belong to the previous footnote.

:param inline: If True, also parse inline footnotes (^[...]).
:param move_to_end: If True, move footnote definitions to the end of the token stream.
:param always_match_refs: If True, match references, even if the footnote is not defined.

footnote_ref()

bool mdit_py_plugins.footnote.index.footnote_ref	(	StateInline	state,
		bool	silent,
		*bool	always_match = False
	)

Process footnote references ([^...])

footnote_tail()

None mdit_py_plugins.footnote.index.footnote_tail

(

StateCore

state

)

Post-processing step, to move footnote tokens to end of the token stream.

Also removes un-referenced tokens.