summaryrefslogtreecommitdiff
path: root/docs/extensions/index.md
blob: 293d1b041f8ec3f7362d1f665696c7bc61137eb2 (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
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's name to markdown with the `extensions` keyword.
See the [Library Reference](../reference.html) for more details. 

    markdown.markdown(some_text, extensions=['extra', 'nl2br'])

From the command line, specify an extension with the `-x` option. See the 
[Command Line docs](../cli.html) or use the `--help` option for more details.

    python -m markdown -x extra input.txt > output.html

Officially Supported Extensions
-------------------------------

The extensions listed below are included with (at least) the most recent release
and are officially supported by Python-Markdown. Any documentation is 
maintained here and all bug reports should be made to the project. If you 
have a typical install of Python-Markdown, these extensions are already 
available to you.

* [Extra](extra.html)
    * [Abbreviations](abbreviations.html)
    * [Attribute Lists](attr_list.html)
    * [Definition Lists](definition_lists.html)
    * [Fenced Code Blocks](fenced_code_blocks.html)
    * [Footnotes](footnotes.html)
    * [Tables](tables.html)
    * [Smart Strong](smart_strong.html)
* [CodeHilite](code_hilite.html)
* [HTML Tidy](html_tidy.html)
* [HeaderId](header_id.html)
* [Meta-Data](meta_data.html)
* [New Line to Break](nl2br.html)
* [RSS](rss.html)
* [Sane Lists](sane_lists.html)
* [Table of Contents](toc.html)
* [WikiLinks](wikilinks.html)

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](https://github.com/waylan/Python-Markdown/wiki/Third-Party-Extensions)
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.

If you would like to write your own extensions, see the 
[Extensions API](api.html) for details.