<!DOCTYPE html> <html> <head> <meta charset=utf-8> <title>Extensions — Python Markdown</title> <link rel="stylesheet" href="../default.css" type="text/css"> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../siteindex.html" title="General Index">index</a></li> <li class="right"> <a href="extra.html" title="Extra Extension" accesskey="N">next</a> |</li> <li class="right"> <a href="../cli.html" title="Command Line" accesskey="P">previous</a> |</li> <li><img src="../py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python Markdown v2.3.1 documentation</a> »</li> <li><a href="index.html">Extensions</a> »</li> </ul> </div> <!-- .related --> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <h1 id="available-extensions">Available Extensions</h1> <p>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.</p> <p>To use an extension, pass it to markdown with the <code>extensions</code> keyword.</p> <pre><code>markdown.markdown(some_text, extensions=[MyExtension(), 'path.to.my.ext', 'footnotes']) </code></pre> <p>See the <a href="../reference.html#extensions">Library Reference</a> for more details.</p> <p>From the command line, specify an extension with the <code>-x</code> option. </p> <pre><code>$ python -m markdown -x footnotes -x tables input.txt > output.html </code></pre> <p>See the <a href="../cli.html">Command Line docs</a> or use the <code>--help</code> option for more details.</p> <div class="admonition seealso"> <p class="admonition-title">See Also</p> <p>If you would like to write your own extensions, see the <a href="api.html">Extension API</a> for details.</p> </div> <h2 id="officially-supported-extensions">Officially Supported Extensions</h2> <p>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 using the "name" listed in the second column below.</p> <table> <thead> <tr> <th>Extension</th> <th>"Name"</th> </tr> </thead> <tbody> <tr> <td><a href="extra.html">Extra</a></td> <td><code>extra</code></td> </tr> <tr> <td> <a href="abbreviations.html">Abbreviations</a></td> <td><code>abbr</code></td> </tr> <tr> <td> <a href="attr_list.html">Attribute Lists</a></td> <td><code>attr_list</code></td> </tr> <tr> <td> <a href="definition_lists.html">Definition Lists</a></td> <td><code>def_list</code></td> </tr> <tr> <td> <a href="fenced_code_blocks.html">Fenced Code Blocks</a></td> <td><code>fenced_code</code></td> </tr> <tr> <td> <a href="footnotes.html">Footnotes</a></td> <td><code>footnotes</code></td> </tr> <tr> <td> <a href="tables.html">Tables</a></td> <td><code>tables</code></td> </tr> <tr> <td> <a href="smart_strong.html">Smart Strong</a></td> <td><code>smart_strong</code></td> </tr> <tr> <td><a href="admonition.html">Admonition</a></td> <td><code>admonition</code></td> </tr> <tr> <td><a href="code_hilite.html">CodeHilite</a></td> <td><code>codehilite</code></td> </tr> <tr> <td><a href="header_id.html">HeaderId</a></td> <td><code>headerid</code></td> </tr> <tr> <td><a href="meta_data.html">Meta-Data</a></td> <td><code>meta</code></td> </tr> <tr> <td><a href="nl2br.html">New Line to Break</a></td> <td><code>nl2br</code></td> </tr> <tr> <td><a href="sane_lists.html">Sane Lists</a></td> <td><code>sane_lists</code></td> </tr> <tr> <td><a href="toc.html">Table of Contents</a></td> <td><code>toc</code></td> </tr> <tr> <td><a href="wikilinks.html">WikiLinks</a></td> <td><code>wikilinks</code></td> </tr> </tbody> </table> <h2 id="third-party-extensions">Third Party Extensions</h2> <p>Various individuals and/or organizations have developed extensions which they have made available to the public. A <a href="https://github.com/waylan/Python-Markdown/wiki/Third-Party-Extensions">list of third party extensions</a> 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.</p> </div> <!-- .body --> </div> <!-- .bodywrapper --> </div> <!-- .documentwrapper --> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3>Table Of Contents</h3> <div class="toc"> <ul> <li><a href="#available-extensions">Available Extensions</a><ul> <li><a href="#officially-supported-extensions">Officially Supported Extensions</a></li> <li><a href="#third-party-extensions">Third Party Extensions</a></li> </ul> </li> </ul> </div> <h4>Previous topic</h4> <p class="topless"><a href="../cli.html" title="previous chapter">Command Line</a></p> <h4>Next topic</h4> <p class="topless"><a href="extra.html" title="next chapter">Extra Extension</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="https://github.com/waylan/Python-Markdown/issues" >Report a Bug</a></li> <li><a href="index.txt" rel="nofollow">Show Source</a></li> </ul> </div> <!-- .sphinxsidebarwrapper --> </div> <!-- .sphinxsidebar --> <div class="clearer"></div> </div> <!-- .document --> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../siteindex.html" title="General Index">index</a></li> <li class="right"> <a href="extra.html" title="Extra Extension" accesskey="N">next</a> |</li> <li class="right"> <a href="../cli.html" title="Command Line" accesskey="P">previous</a> |</li> <li><img src="../py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python Markdown v2.3.1 documentation</a> »</li> <li><a href="index.html">Extensions</a> »</li> </ul> </div> <!-- .related --> <div class="footer">© 2010-2012 Python Markdown Project</div> </body> </html>