mdit_py_plugins.front_matter.index Namespace Reference

Functions
None	front_matter_plugin (MarkdownIt md)
bool	_front_matter_rule (StateBlock state, int startLine, int endLine, bool silent)

Detailed Description

Process front matter.

Function Documentation

front_matter_plugin()

None mdit_py_plugins.front_matter.index.front_matter_plugin

(

MarkdownIt

md

)

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

It parses initial metadata, stored between opening/closing dashes:

.. code-block:: md

    ---
    valid-front-matter: true
    ---