-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathindex.html
302 lines (260 loc) · 11.5 KB
/
index.html
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="author" content="The Python-Markdown Project">
<link rel="canonical" href="https://Python-Markdown.github.io/extensions/">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Abbreviations" href="abbreviations/" />
<link rel="prev" title="Command Line" href="../cli/" />
<title>Extensions — Python-Markdown 3.8 documentation</title>
<link rel="stylesheet" href="../static/nature.css" type="text/css" />
<link rel="stylesheet" href="../static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../assets/_mkdocstrings.css" type="text/css" />
<link rel="stylesheet" href="../custom.css" type="text/css" />
<link rel="stylesheet" href="../mkdocstrings.css" type="text/css" />
<script type="text/javascript" src="../static/jquery.js"></script>
<script type="text/javascript" src="../static/underscore.js"></script>
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="https://github.com/Python-Markdown/markdown" title="View this project on GitHub"><img src="../static/github.png" width=16px style="vertical-align: middle; margin-top: -1px" /></a>
</li>
<li class="right" style="margin-right: 10px">
<a href="../sitemap.html" title="Sitemap" accesskey="I">index</a>
</li>
<li class="right">
<a href="abbreviations/" title="Abbreviations" accesskey="N">next</a> |
</li>
<li class="right">
<a href="../cli/" title="Command Line" accesskey="P">previous</a> |
</li>
<li><img src="../py.png"
alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
<li class="nav-item nav-item-0">
<a href="..">Python-Markdown 3.8 documentation</a> »
</li>
<li class="nav-item">
<a href="./">Extensions</a>
» </li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main"><h1 id="extensions">Extensions<a class="headerlink" href="#extensions" title="Permanent link">¶</a></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 class="codehilite"><code class="language-python">markdown.markdown(some_text, extensions=[MyExtClass(), 'myext', 'path.to.my.ext:MyExtClass'])
</code></pre>
<p>See the <a href="../reference/#extensions">Library Reference</a> for more details.</p>
<p>From the command line, specify an extension with the <code>-x</code> option.</p>
<pre class="codehilite"><code class="language-bash">python -m markdown -x myext -x path.to.module:MyExtClass input.txt > output.html
</code></pre>
<p>See the <a href="../cli/">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/">Extension API</a> for details.</p>
</div>
<h2 id="officially-supported-extensions">Officially Supported Extensions<a class="headerlink" href="#officially-supported-extensions" title="Permanent link">¶</a></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 “Entry Point” name listed in the second column below.</p>
<table>
<thead>
<tr>
<th>Extension</th>
<th>Entry Point</th>
<th>Dot Notation</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="extra/">Extra</a></td>
<td><code>extra</code></td>
<td><code>markdown.extensions.extra</code></td>
</tr>
<tr>
<td> <a href="abbreviations/">Abbreviations</a></td>
<td><code>abbr</code></td>
<td><code>markdown.extensions.abbr</code></td>
</tr>
<tr>
<td> <a href="attr_list/">Attribute Lists</a></td>
<td><code>attr_list</code></td>
<td><code>markdown.extensions.attr_list</code></td>
</tr>
<tr>
<td> <a href="definition_lists/">Definition Lists</a></td>
<td><code>def_list</code></td>
<td><code>markdown.extensions.def_list</code></td>
</tr>
<tr>
<td> <a href="fenced_code_blocks/">Fenced Code Blocks</a></td>
<td><code>fenced_code</code></td>
<td><code>markdown.extensions.fenced_code</code></td>
</tr>
<tr>
<td> <a href="footnotes/">Footnotes</a></td>
<td><code>footnotes</code></td>
<td><code>markdown.extensions.footnotes</code></td>
</tr>
<tr>
<td> <a href="md_in_html/">Markdown in HTML</a></td>
<td><code>md_in_html</code></td>
<td><code>markdown.extensions.md_in_html</code></td>
</tr>
<tr>
<td> <a href="tables/">Tables</a></td>
<td><code>tables</code></td>
<td><code>markdown.extensions.tables</code></td>
</tr>
<tr>
<td><a href="admonition/">Admonition</a></td>
<td><code>admonition</code></td>
<td><code>markdown.extensions.admonition</code></td>
</tr>
<tr>
<td><a href="code_hilite/">CodeHilite</a></td>
<td><code>codehilite</code></td>
<td><code>markdown.extensions.codehilite</code></td>
</tr>
<tr>
<td><a href="legacy_attrs/">Legacy Attributes</a></td>
<td><code>legacy_attrs</code></td>
<td><code>markdown.extensions.legacy_attrs</code></td>
</tr>
<tr>
<td><a href="legacy_em/">Legacy Emphasis</a></td>
<td><code>legacy_em</code></td>
<td><code>markdown.extensions.legacy_em</code></td>
</tr>
<tr>
<td><a href="meta_data/">Meta-Data</a></td>
<td><code>meta</code></td>
<td><code>markdown.extensions.meta</code></td>
</tr>
<tr>
<td><a href="nl2br/">New Line to Break</a></td>
<td><code>nl2br</code></td>
<td><code>markdown.extensions.nl2br</code></td>
</tr>
<tr>
<td><a href="sane_lists/">Sane Lists</a></td>
<td><code>sane_lists</code></td>
<td><code>markdown.extensions.sane_lists</code></td>
</tr>
<tr>
<td><a href="smarty/">SmartyPants</a></td>
<td><code>smarty</code></td>
<td><code>markdown.extensions.smarty</code></td>
</tr>
<tr>
<td><a href="toc/">Table of Contents</a></td>
<td><code>toc</code></td>
<td><code>markdown.extensions.toc</code></td>
</tr>
<tr>
<td><a href="wikilinks/">WikiLinks</a></td>
<td><code>wikilinks</code></td>
<td><code>markdown.extensions.wikilinks</code></td>
</tr>
</tbody>
</table>
<h2 id="third-party-extensions">Third Party Extensions<a class="headerlink" href="#third-party-extensions" title="Permanent link">¶</a></h2>
<p>Various individuals and/or organizations have developed extensions which they
have made available to the public. A <a href="https://github.com/Python-Markdown/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>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li>
<a class="reference internal" href="#extensions">Extensions</a>
<ul>
<li>
<a class="reference internal" href="#officially-supported-extensions">Officially Supported Extensions</a>
</li>
<li>
<a class="reference internal" href="#third-party-extensions">Third Party Extensions</a>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless">
<a href="../cli/" title="previous page">Command Line</a>
</p>
<h4>Next topic</h4>
<p class="topless">
<a href="abbreviations/" title="next page">Abbreviations</a>
</p>
<div role="note" aria-label="source link">
<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="https://github.com/Python-Markdown/markdown/edit/master/docs/extensions/index.md">Edit on GitHub</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" placeholder="Search docs" /></div>
<div><input type="submit" value="Go" /></div>
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="https://github.com/Python-Markdown/markdown" title="View this project on GitHub"><img src="../static/github.png" width=16px style="vertical-align: middle; margin-top: -1px" /></a>
</li>
<li class="right" style="margin-right: 10px">
<a href="../sitemap.html" title="Sitemap" accesskey="I">index</a>
</li>
<li class="right">
<a href="abbreviations/" title="Abbreviations" accesskey="N">next</a> |
</li>
<li class="right">
<a href="../cli/" title="Command Line" accesskey="P">previous</a> |
</li>
<li><img src="../py.png"
alt="icon" style="vertical-align: middle; margin-top: -1px"/></li>
<li class="nav-item nav-item-0">
<a href="..">Python-Markdown 3.8 documentation</a> »
</li>
<li class="nav-item">
<a href="./">Extensions</a>
» </li>
</ul>
</div>
<div class="footer" role="contentinfo">Copyright © 2010-2023, The Python-Markdown Project.
Created using <a href="https://www.mkdocs.org/">MkDocs</a> 1.6.1.
</div>
<script>var base_url = '..';</script>
<script src="../search/main.js"></script>
<!--
MkDocs version : 1.6.1
Docs Build Date UTC : 2025-04-09 17:38:32.469494+00:00
-->
</body>
</html>