diff options
author | Waylan Limberg <waylan@gmail.com> | 2009-03-18 23:29:40 -0400 |
---|---|---|
committer | Waylan Limberg <waylan@gmail.com> | 2009-03-18 23:29:40 -0400 |
commit | 70c81659eca814bb037b93c95996210d192e5ca5 (patch) | |
tree | 20b523620683e1d3efc30c3049e8a3ea2d9a7eb0 /docs/extensions/Definition_Lists.txt | |
parent | e4508b2a767e0679bca71086890998d5e328517d (diff) | |
download | markdown-70c81659eca814bb037b93c95996210d192e5ca5.tar.gz markdown-70c81659eca814bb037b93c95996210d192e5ca5.tar.bz2 markdown-70c81659eca814bb037b93c95996210d192e5ca5.zip |
Added documentation for Extra Extension and all the extentions it supports. Still need to do non-extra extensions.
Diffstat (limited to 'docs/extensions/Definition_Lists.txt')
-rw-r--r-- | docs/extensions/Definition_Lists.txt | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/extensions/Definition_Lists.txt b/docs/extensions/Definition_Lists.txt new file mode 100644 index 0000000..983070d --- /dev/null +++ b/docs/extensions/Definition_Lists.txt @@ -0,0 +1,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 |