mdit_py_plugins.field_list Namespace Reference

Functions
None	fieldlist_plugin (MarkdownIt md)
tuple[int, str]	parseNameMarker (StateBlock state, int startLine)
Iterator[None]	set_parent_type (StateBlock state, str name)
bool	_fieldlist_rule (StateBlock state, int startLine, int endLine, bool silent)
Iterator[None]	temp_state_changes (StateBlock state, int startLine)

Detailed Description

Field list plugin

Function Documentation

fieldlist_plugin()

None mdit_py_plugins.field_list.fieldlist_plugin

(

MarkdownIt

md

)

Field lists are mappings from field names to field bodies, based on the
`reStructureText syntax
<https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists>`_.

.. code-block:: md

    :name *markup*:
    :name1: body content
    :name2: paragraph 1

            paragraph 2
    :name3:
      paragraph 1

      paragraph 2

A field name may consist of any characters except colons (":").
Inline markup is parsed in field names.

The field name is followed by whitespace and the field body.
The field body may be empty or contain multiple body elements.

Since the field marker may be quite long,
the second and subsequent lines of the field body do not have to
line up with the first line, but they must be indented relative to the
field name marker, and they must line up with each other.

parseNameMarker()

tuple[int, str] mdit_py_plugins.field_list.parseNameMarker	(	StateBlock	state,
		int	startLine
	)

Parse field name: `:name:`

:returns: position after name marker, name text

set_parent_type()

Iterator[None] mdit_py_plugins.field_list.set_parent_type	(	StateBlock	state,
		str	name
	)

Temporarily set parent type to `name`

temp_state_changes()

Iterator[None] mdit_py_plugins.field_list.temp_state_changes	(	StateBlock	state,
		int	startLine
	)

Allow temporarily changing certain state attributes.