blob: 047996acf07ebff5685aa709f98c01b3e88fa0f3 (
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
56
57
58
|
title: Definition Lists Extension
Definition Lists
================
Summary
-------
The Definition Lists extension adds the ability to create definition lists 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):
```md
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 as:
```html
<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
-----
See [Extensions](index.md) for general extension usage. Use `def_list` as the
name of the extension.
This extension does not accept any special configuration options.
A trivial example:
```python
markdown.markdown(some_text, extensions=['def_list'])
```
|
