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