blob: aaffc09e54835c4ffe081e84eaece62344b679b2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
|
title: Tables Extension
Tables
======
Summary
-------
The Tables extension adds the ability to create tables in Markdown documents.
This extension is included in the standard Markdown library.
Syntax
------
Tables are defined using the syntax established in [PHP Markdown Extra][php].
[php]: http://www.michelf.com/projects/php-markdown/extra/#table
Thus, the following text (taken from the above referenced PHP documentation):
```md
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell
```
will be rendered as:
```html
<table>
<thead>
<tr>
<th>First Header</th>
<th>Second Header</th>
</tr>
</thead>
<tbody>
<tr>
<td>Content Cell</td>
<td>Content Cell</td>
</tr>
<tr>
<td>Content Cell</td>
<td>Content Cell</td>
</tr>
</tbody>
</table>
```
!!! seealso "See Also"
The [Attribute Lists](./attr_list.md) extension includes support for defining attributes on table cells.
Usage
-----
See [Extensions](index.md) for general extension usage. Use `tables` as the
name of the extension.
See the [Library Reference](../reference.md#extensions) for information about
configuring extensions.
The following options are provided to change the default behavior:
* **`use_align_attribute`**: Set to `True` to use `align` instead of an appropriate `style` attribute
Default: `'False'`
A trivial example:
```python
markdown.markdown(some_text, extensions=['tables'])
```
### Examples
For an example, let us suppose that alignment should be controlled by the legacy `align`
attribute.
```pycon
>>> from markdown.extensions.tables import TableExtension
>>> html = markdown.markdown(text,
... extensions=[TableExtension(use_align_attribute=True)]
... )
```
|
