mdit_py_plugins.subscript Namespace Reference

Functions
bool	tokenize (StateInline state, bool silent)
str	sub_open (RendererHTML renderer, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
str	sub_close (RendererHTML renderer, Sequence[Token] tokens, int idx, OptionsDict options, EnvType env)
None	sub_plugin (MarkdownIt md)

Variables
str	TILDE_CHAR = "~"
	WHITESPACE_RE = re.compile(r"(^|[^\\])(\\\\‍)*\s")
	UNESCAPE_RE = re.compile(r'\\‍([ \\!"#$%&\'()*+,.\/:;<=>?@[\]^_`{|}~-])')

Detailed Description

Markdown-it-py plugin to introduce <sub> markup using ~subscript~.

Ported from
https://github.com/markdown-it/markdown-it-sub/blob/master/index.mjs

Originally ported during implementation of https://github.com/hasgeek/funnel/blob/main/funnel/utils/markdown/mdit_plugins/sub_tag.py

Function Documentation

sub_close()

str mdit_py_plugins.subscript.sub_close	(	RendererHTML	renderer,
		Sequence[Token]	tokens,
		int	idx,
		OptionsDict	options,
		EnvType	env
	)

Render the closing tag for a ~subscript~ token.

sub_open()

str mdit_py_plugins.subscript.sub_open	(	RendererHTML	renderer,
		Sequence[Token]	tokens,
		int	idx,
		OptionsDict	options,
		EnvType	env
	)

Render the opening tag for a ~subscript~ token.

sub_plugin()

None mdit_py_plugins.subscript.sub_plugin

(

MarkdownIt

md

)

Markdown-it-py plugin to introduce <sub> markup using ~subscript~.

Ported from
https://github.com/markdown-it/markdown-it-sub/blob/master/index.mjs

Originally ported during implementation of https://github.com/hasgeek/funnel/blob/main/funnel/utils/markdown/mdit_plugins/sub_tag.py

tokenize()

bool mdit_py_plugins.subscript.tokenize	(	StateInline	state,
		bool	silent
	)

Parse a ~subscript~ token.