md_multiline_table
md_multiline_table ¶
Multiline Table extension for Python Markdown.
Classes:
| Name | Description |
|---|---|
MultilineTableExtension | Multiline Table Python Markdown extension. |
MultilineTableProcessor | Multiline Table Python Markdown extension markdown code block processor. |
Functions:
| Name | Description |
|---|---|
make_extension | Make a new instance of |
Classes¶
MultilineTableExtension ¶
Bases: TableExtension
flowchart TD
md_multiline_table.MultilineTableExtension[MultilineTableExtension]
click md_multiline_table.MultilineTableExtension href "" "md_multiline_table.MultilineTableExtension"
Multiline Table Python Markdown extension.
- API Reference
md multiline table md_multiline_tablemd_multiline_table Functions:make_extension
Methods:
| Name | Description |
|---|---|
extendMarkdown | Extend markdown instance with multiline table extension. |
Source code in src/md_multiline_table/__init__.py
Methods:¶
extendMarkdown ¶
extendMarkdown(md: Markdown) -> None
Extend markdown instance with multiline table extension.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
md ¶ | Markdown | markdown instance to extend | required |
Source code in src/md_multiline_table/__init__.py
MultilineTableProcessor ¶
Bases: TableProcessor
flowchart TD
md_multiline_table.MultilineTableProcessor[MultilineTableProcessor]
click md_multiline_table.MultilineTableProcessor href "" "md_multiline_table.MultilineTableProcessor"
Multiline Table Python Markdown extension markdown code block processor.
Methods:
| Name | Description |
|---|---|
__init__ | Initialize new instance of the multiline table python extension markdown block processor. |
run | Transform multiline table to standard markdown table. |
test | Ensure that the first few rows contains a valid table head (column header and separator row). |
Attributes:
| Name | Type | Description |
|---|---|---|
RE_END_BORDER | |
Source code in src/md_multiline_table/__init__.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 | |
Attributes¶
RE_END_BORDER class-attribute instance-attribute ¶
Methods:¶
__init__ ¶
Initialize new instance of the multiline table python extension markdown block processor.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
parser ¶ | BlockParser | block parser | required |
config ¶ | dict[str, Any] | all configuration options | required |
Source code in src/md_multiline_table/__init__.py
run ¶
Transform multiline table to standard markdown table.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
parent ¶ | Element | parent html element | required |
blocks ¶ | list[str] | markdown code blocks | required |
Source code in src/md_multiline_table/__init__.py
test ¶
Ensure that the first few rows contains a valid table head (column header and separator row).
This method does exactly the same like its super() version except that the separator row does not have to be in the second row to support multiline headers. See variable format_row.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
parent ¶ | Element | parent html element | required |
block ¶ | str | markdown code | required |
Returns:
| Name | Type | Description |
|---|---|---|
bool | bool | whether markdown code is a table or not |
Source code in src/md_multiline_table/__init__.py
Functions:¶
make_extension ¶
make_extension(*_args, **kwargs) -> MultilineTableExtension
Make a new instance of MultilineTableExtension.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| Will be ignored. | () | |
| Further Extension arguments. | {} |
Returns:
| Name | Type | Description |
|---|---|---|
MultilineTableExtension | MultilineTableExtension | new instance of MultilineTableExtension |