1Python-Markdown Extra
2=====================
3
4Summary
5-------
6
7A compilation of various Python-Markdown extensions that (mostly) imitates
8[PHP Markdown Extra](http://michelf.com/projects/php-markdown/extra/).
9
10The supported extensions include:
11
12* [[Abbreviations]]
13* [[Definition_Lists]]
14* [[Fenced_Code_Blocks]]
15* [[Footnotes]]
16* [[HeaderId]]
17* [[Tables]]
18
19See each individual extension for syntax documentation. Extra and all it's
20supported extensions are included in the standard Markdown library.
21
22Usage
23-----
24
25From the Python interpreter:
26
27    >>> import markdown
28    >>> html = markdown.markdown(text, ['extra'])
29
30In the unlikely event that one or more of the supported extensions are not
31available for import, Markdown will simply continue without that
32extension. If you would like to be notified of such failures,
33you may set Python-Markdown's logger level to "WARN".
34
35There may be additional extensions that are distributed with
36Python-Markdown that are not included here in Extra. Those extensions
37are not part of PHP Markdown Extra, and therefore, not part of
38Python-Markdown Extra. If you really would like Extra to include
39additional extensions, we suggest creating your own clone of Extra
40under a different name (see [[Writing Extensions]]). You could also
41edit the `extensions` global variable defined in the source, but be
42aware that such changes may be lost when you upgrade to any future
43version of Python-Markdown.
44