blob: 2e735728b3fc2ee791acd9fbcce6f80e0c28796d (
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
|
title: Extensions
prev_title: Command Line
prev_url: ../cli.html
next_title: Extra Extension
next_url: extra.html
Available Extensions
====================
Python Markdown offers a flexible extension mechanism, which makes it possible
to change and/or extend the behavior of the parser without having to edit the
actual source files.
To use an extension, pass it to markdown with the `extensions` keyword.
markdown.markdown(some_text, extensions=[MyExtension(), 'path.to.my.ext', 'markdown.extensions.footnotes'])
See the [Library Reference](../reference.md#extensions) for more details.
From the command line, specify an extension with the `-x` option.
$ python -m markdown -x markdown.extensions.footnotes -x markdown.extensions.tables input.txt > output.html
See the [Command Line docs](../cli.md) or use the `--help` option for more details.
!!! seealso "See Also"
If you would like to write your own extensions, see the
[Extension API](api.md) for details.
Officially Supported Extensions
-------------------------------
The extensions listed below are maintained and officially supported by
the Python-Markdown team. However, no extensions ship with Python-Markdown
by default. If you would like to use any of the extensions listed below,
you will need to install each of them individually. See the documentation
for each extension for specifics in instalation and usage.
Extension | "Name"
------------------------------------ | ---------------
[Extra] | `extra`
[Abbreviations][] | `abbr`
[Attribute Lists][] | `attr_list`
[Definition Lists][] | `def_list`
[Fenced Code Blocks][] | `fenced_code`
[Footnotes][] | `footnotes`
[Tables][] | `tables`
[Smart Strong][] | `smart_strong`
[Admonition][] | `admonition`
[CodeHilite][] | `codehilite`
[Meta-Data] | `meta`
[New Line to Break] | `nl2br`
[Sane Lists] | `sane_lists`
[SmartyPants] | `smarty`
[Table of Contents] | `toc`
[WikiLinks] | `wikilinks`
[Extra]: https://github.com/Python-Markdown/mdx_extra
[Abbreviations]: https://github.com/Python-Markdown/mdx_abbreviations
[Attribute Lists]: https://github.com/Python-Markdown/mdx_attr_list
[Definition Lists]: https://github.com/Python-Markdown/mdx_definition_lists
[Fenced Code Blocks]: https://github.com/Python-Markdown/mdx_fenced_code_blocks
[Footnotes]: https://github.com/Python-Markdown/mdx_footnotes
[Tables]: https://github.com/Python-Markdown/mdx_tables
[Smart Strong]: https://github.com/Python-Markdown/mdx_smart_strong
[Admonition]: https://github.com/Python-Markdown/mdx_admonition
[CodeHilite]: https://github.com/Python-Markdown/mdx_code_hilite
[Meta-Data]: https://github.com/Python-Markdown/mdx_meta_data
[New Line to Break]: https://github.com/Python-Markdown/mdx_nl2br
[Sane Lists]: https://github.com/Python-Markdown/mdx_sane_lists
[SmartyPants]: https://github.com/Python-Markdown/mdx_smarty
[Table of Contents]: https://github.com/Python-Markdown/mdx_toc
[WikiLinks]: https://github.com/Python-Markdown/mdx_wikilinks
Third Party Extensions
----------------------
Various individuals and/or organizations have developed extensions which they
have made available to the public. A [list of third party extensions][list]
is maintained on the wiki for your convenience. The Python-Markdown team
offers no official support for these extensions. Please see the developer of
each extension for support.
[list]: https://github.com/Python-Markdown/markdown/wiki/Third-Party-Extensions
|
