python-markdown-doc 2.6.9-1 / usr / share / doc / python-markdown-doc / docs / extensions / sane_lists.html

This file is indexed.

/usr/share/doc/python-markdown-doc/docs/extensions/sane_lists.html is in python-markdown-doc 2.6.9-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<!DOCTYPE html>
<html>
<head>
<meta charset=utf-8>
<title>Sane Lists Extension &#8212; 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="smarty.html" title="SmartyPants Extension"
         accesskey="N">next</a> |</li>
    <li class="right">
      <a href="nl2br.html" title="New Line to Break 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.6.9 documentation</a> &raquo;</li>
    <li><a href="index.html">Extensions</a> &raquo;</li>
<li><a href="sane_lists.html">Sane Lists Extension</a> &raquo;</li>
  </ul>
</div> <!-- .related -->

<div class="document">
  <div class="documentwrapper">
    <div class="bodywrapper">
      <div class="body">
<h1 id="sane-lists">Sane Lists<a class="headerlink" href="#sane-lists" title="Permanent link">&para;</a></h1>
<h2 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent link">&para;</a></h2>
<p>The Sane Lists extension alters the behavior of the Markdown List syntax
to be less surprising.</p>
<p>This extension is included in the standard Markdown library.</p>
<h2 id="syntax">Syntax<a class="headerlink" href="#syntax" title="Permanent link">&para;</a></h2>
<p>Sane Lists do not allow the mixing of list types. In other words, an ordered
list will not continue when an unordered list item is encountered and
vice versa. For example:</p>
<pre><code>1. Ordered item 1
2. Ordered item 2

* Unordered item 1
* Unordered item 2
</code></pre>
<p>will result in the following output:</p>
<pre><code>&lt;ol&gt;
  &lt;li&gt;Ordered item 1&lt;/li&gt;
  &lt;li&gt;Ordered item 2&lt;/li&gt;
&lt;/ol&gt;

&lt;ul&gt;
  &lt;li&gt;Unordered item 1&lt;/li&gt;
  &lt;li&gt;Unordered item 2&lt;/li&gt;
&lt;/ul&gt;
</code></pre>
<p>Whereas the default Markdown behavior would be to generate an unordered list.</p>
<p>Note that, unlike the default Markdown behavior, if a blank line is not
included between list items, the different list type is ignored completely. 
This corresponds to the behavior of paragraphs. For example:</p>
<pre><code>A Paragraph.
* Not a list item.

1. Ordered list item.
* Not a separate list item.
</code></pre>
<p>With this extension the above will result in the following output:</p>
<pre><code>&lt;p&gt;A Paragraph.
* Not a list item.&lt;/p&gt;

&lt;ol&gt;
  &lt;li&gt;Ordered list item.
  * Not a separate list item.&lt;/li&gt;
&lt;/ol&gt;
</code></pre>
<p>In all other ways, Sane Lists should behave as normal Markdown lists.</p>
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h2>
<p>See <a href="index.html">Extensions</a> for general extension usage, specify <code>markdown.extensions.sane_lists</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="#sane-lists">Sane 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="nl2br.html"
         title="previous chapter">New Line to Break Extension</a></p>
    <h4>Next topic</h4>
      <p class="topless"><a href="smarty.html"
         title="next chapter">SmartyPants Extension</a></p>
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="https://github.com/Python-Markdown/markdown/issues"
             >Report a Bug</a></li>
      <li><a href="sane_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="smarty.html" title="SmartyPants Extension"
         accesskey="N">next</a> |</li>
    <li class="right">
      <a href="nl2br.html" title="New Line to Break 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.6.9 documentation</a> &raquo;</li>
    <li><a href="index.html">Extensions</a> &raquo;</li>
<li><a href="sane_lists.html">Sane Lists Extension</a> &raquo;</li>
  </ul>
</div> <!-- .related -->

<div class="footer">&copy; 2010-2012 Python Markdown Project</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.