blob: 983070d9ebcae0be2653b82573d99f1b34099622 (
plain)
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
|
Definition Lists
----------------
Summary
-------
The Definition List Extension adds the ability to create definition list in
Markdown documents.
This extension is included in the standard Markdown library.
Syntax
------
Definition lists are defined using the syntax established in
[PHP Markdown Extra][php].
[php]: http://www.michelf.com/projects/php-markdown/extra/#def-list
Thus, the following text (taken from the above referenced PHP documentation):
Apple
: Pomaceous fruit of plants of the genus Malus in
the family Rosaceae.
Orange
: The fruit of an evergreen tree of the genus Citrus.
will be rendered like so:
<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>
Usage
-----
From the Python interpreter:
>>> html = markdown.markdown(text, ['def_list'])
To use with other extensions, just add them to the list, like this:
>>> html = markdown.markdown(text, ['def_list', 'footnotes'])
The extension can also be called from the command line using Markdown's `-x`
parameter:
markdown.py -x def_list source.txt > output.html
|
