mdit_py_plugins.container.index Namespace Reference

Functions
None	container_plugin (MarkdownIt md, str name, str marker=":", None|Callable[[str, str], bool] validate=None, None|Callable[..., str] render=None)

Detailed Description

Process block-level custom containers.

Function Documentation

container_plugin()

None mdit_py_plugins.container.index.container_plugin	(	MarkdownIt	md,
		str	name,
		str	marker = ":",
		None | Callable[[str, str], bool]	validate = None,
		None | Callable[..., str]	render = None
	)

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

It is a plugin for creating block-level custom containers:

.. code-block:: md

    :::: name
    ::: name
    *markdown*
    :::
    ::::

:param name: the name of the container to parse
:param marker: the marker character to use
:param validate: func(marker, param) -> bool, default matches against the name
:param render: render func