• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1title: Definition Lists Extension
2
3Definition Lists
4================
5
6Summary
7-------
8
9The Definition Lists extension adds the ability to create definition lists in
10Markdown documents.
11
12This extension is included in the standard Markdown library.
13
14Syntax
15------
16
17Definition lists are defined using the syntax established in
18[PHP Markdown Extra][php].
19
20[php]: http://www.michelf.com/projects/php-markdown/extra/#def-list
21
22Thus, the following text (taken from the above referenced PHP documentation):
23
24```md
25Apple
26:   Pomaceous fruit of plants of the genus Malus in
27    the family Rosaceae.
28
29Orange
30:   The fruit of an evergreen tree of the genus Citrus.
31```
32
33will be rendered as:
34
35```html
36<dl>
37<dt>Apple</dt>
38<dd>Pomaceous fruit of plants of the genus Malus in
39the family Rosaceae.</dd>
40
41<dt>Orange</dt>
42<dd>The fruit of an evergreen tree of the genus Citrus.</dd>
43</dl>
44```
45
46Usage
47-----
48
49See [Extensions](index.md) for general extension usage. Use `def_list` as the
50name of the extension.
51
52This extension does not accept any special configuration options.
53
54A trivial example:
55
56```python
57markdown.markdown(some_text, extensions=['def_list'])
58```
59