<!DOCTYPE html> <html> <head> <meta charset=utf-8> <title>Definition Lists Extension — 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="fenced_code_blocks.html" title="Fenced Code Blocks Extension" accesskey="N">next</a> |</li> <li class="right"> <a href="attr_list.html" title="Attribute Lists Extension" 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.4.1 documentation</a> »</li> <li><a href="index.html">Extensions</a> »</li> <li><a href="definition_lists.html">Definition Lists Extension</a> »</li> </ul> </div> <!-- .related --> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <h1 id="definition-lists">Definition Lists<a class="headerlink" href="#definition-lists" title="Permanent link">¶</a></h1> <h2 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent link">¶</a></h2> <p>The Definition Lists extension adds the ability to create definition lists in Markdown documents.</p> <p>This extension is included in the standard Markdown library.</p> <h2 id="syntax">Syntax<a class="headerlink" href="#syntax" title="Permanent link">¶</a></h2> <p>Definition lists are defined using the syntax established in <a href="http://www.michelf.com/projects/php-markdown/extra/#def-list">PHP Markdown Extra</a>.</p> <p>Thus, the following text (taken from the above referenced PHP documentation):</p> <pre><code>Apple : Pomaceous fruit of plants of the genus Malus in the family Rosaceae. Orange : The fruit of an evergreen tree of the genus Citrus. </code></pre> <p>will be rendered as:</p> <pre><code><dl> <dt>Apple</dt> <dd>Pomaceous fruit of plants of the genus Malus in the family Rosaceae.</dd> <dt>Orange</dt> <dd>The fruit of an evergreen tree of the genus Citrus.</dd> </dl> </code></pre> <h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h2> <p>See <a href="index.html">Extensions</a> for general extension usage, specify <code>def_list</code> as the name of the extension.</p> <p>This extension does not accept any special configuration options.</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="#definition-lists">Definition Lists</a><ul> <li><a href="#summary">Summary</a></li> <li><a href="#syntax">Syntax</a></li> <li><a href="#usage">Usage</a></li> </ul> </li> </ul> </div> <h4>Previous topic</h4> <p class="topless"><a href="attr_list.html" title="previous chapter">Attribute Lists Extension</a></p> <h4>Next topic</h4> <p class="topless"><a href="fenced_code_blocks.html" title="next chapter">Fenced Code Blocks 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="definition_lists.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="fenced_code_blocks.html" title="Fenced Code Blocks Extension" accesskey="N">next</a> |</li> <li class="right"> <a href="attr_list.html" title="Attribute Lists Extension" 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.4.1 documentation</a> »</li> <li><a href="index.html">Extensions</a> »</li> <li><a href="definition_lists.html">Definition Lists Extension</a> »</li> </ul> </div> <!-- .related --> <div class="footer">© 2010-2012 Python Markdown Project</div> </body> </html>