mdit_py_plugins.tasklists Namespace Reference

Functions
None	tasklists_plugin (MarkdownIt md, bool enabled=False, bool label=False, bool label_after=False)

Variables
str	_GFM_WHITESPACE_RE = r"[ \t\n\v\f\r]"

Detailed Description

Builds task/todo lists out of markdown lists with items starting with [ ] or [x]

Function Documentation

tasklists_plugin()

None mdit_py_plugins.tasklists.tasklists_plugin	(	MarkdownIt	md,
		bool	enabled = False,
		bool	label = False,
		bool	label_after = False
	)

Plugin for building task/todo lists out of markdown lists with items starting with [ ] or [x]
.. Nothing else

For example::
   - [ ] An item that needs doing
   - [x] An item that is complete

The rendered HTML checkboxes are disabled; to change this, pass a truthy value into the enabled
property of the plugin options.

:param enabled: True enables the rendered checkboxes
:param label: True wraps the rendered list items in a <label> element for UX purposes,
:param label_after: True adds the <label> element after the checkbox.