Module

plugins.task_lists

Task list plugin for Patitas.

Adds support for checkbox task lists.

Usage:

>>> md = create_markdown(plugins=["task_lists"])
>>> md("- [ ] Unchecked
  • Checked")
'<ul><li class="task-list-item"><input type="checkbox" disabled> Unchecked</li>...'

Syntax:

  • Unchecked task
  • Checked task
  • Also checked (uppercase)

Works with ordered lists too:

  1. First task
  2. Second task

Notes:

  • Checkboxes are rendered disabled by default
  • The ListItem node has acheckedfield (True/False/None)
  • Task list support is enabled by default in core parser

Thread Safety:

This plugin is stateless and thread-safe.

1Class

Classes

TaskListPlugin 4 ▼
Plugin for task list checkbox support. Task lists are partially built into the core parser via the…

Plugin for task list checkbox support.

Task lists are partially built into the core parser via the ListItem.checked field. This plugin enables checkbox detection.

Methods

name 0 str ▼
property
def name(self) -> str
Returns
str
extend_lexer 1 ▼
Enable task list detection in lexer.
def extend_lexer(self, lexer_class: type[Lexer]) -> None
Parameters
Name Type Description
lexer_class —
extend_parser 1 ▼
Enable task list parsing.
def extend_parser(self, parser_class: type[Parser]) -> None
Parameters
Name Type Description
parser_class —
extend_renderer 1 ▼
Task list rendering is handled in base renderer.
def extend_renderer(self, renderer_class: type[HtmlRenderer]) -> None
Parameters
Name Type Description
renderer_class —