| 1 |
title: Definition Lists Extension |
| 2 |
|
| 3 |
Definition Lists |
| 4 |
================ |
| 5 |
|
| 6 |
Summary |
| 7 |
------- |
| 8 |
|
| 9 |
The Definition Lists extension adds the ability to create definition lists in |
| 10 |
Markdown documents. |
| 11 |
|
| 12 |
This extension is included in the standard Markdown library. |
| 13 |
|
| 14 |
Syntax |
| 15 |
------ |
| 16 |
|
| 17 |
Definition 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 |
|
| 22 |
Thus, the following text (taken from the above referenced PHP documentation): |
| 23 |
|
| 24 |
```md |
| 25 |
Apple |
| 26 |
: Pomaceous fruit of plants of the genus Malus in |
| 27 |
the family Rosaceae. |
| 28 |
|
| 29 |
Orange |
| 30 |
: The fruit of an evergreen tree of the genus Citrus. |
| 31 |
``` |
| 32 |
|
| 33 |
will be rendered as: |
| 34 |
|
| 35 |
```html |
| 36 |
<dl> |
| 37 |
<dt>Apple</dt> |
| 38 |
<dd>Pomaceous fruit of plants of the genus Malus in |
| 39 |
the 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 |
|
| 46 |
Usage |
| 47 |
----- |
| 48 |
|
| 49 |
See [Extensions](index.md) for general extension usage. Use `def_list` as the |
| 50 |
name of the extension. |
| 51 |
|
| 52 |
This extension does not accept any special configuration options. |
| 53 |
|
| 54 |
A trivial example: |
| 55 |
|
| 56 |
```python |
| 57 |
markdown.markdown(some_text, extensions=['def_list']) |
| 58 |
``` |