Module

plugins.table

Table plugin for Patitas (GFM-style pipe tables).

Adds support for GitHub-Flavored Markdown tables.

Usage:

>>> md = create_markdown(plugins=["table"])
>>> md("| A | B |

|---|---| | 1 | 2 |") '

...'

Syntax:

AB
Header 1 Header 2
Cell 1 Cell 2

Alignment:

Left Center Right
L C R

Features:

  • Column alignment via :--- :--: ---:
  • Inline markdown in cells
  • Pipes can be escaped with\|

Thread Safety:

This plugin is stateless and thread-safe.

1Class

Classes

TablePlugin 4 ▼
Plugin adding GFM table support. Tables are detected at the block level when a line starts with | …

Plugin adding GFM table support.

Tables are detected at the block level when a line starts with | and is followed by a delimiter row (|---|---|).

Methods

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