aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/definition_lists.md
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2012-03-07 09:35:40 -0500
committerWaylan Limberg <waylan@gmail.com>2012-03-07 09:35:40 -0500
commitec46692cf5c4d5e22950bc8e7d14cb0ec327fb87 (patch)
tree9c1b9c5025948204e415a21938469bf50bbae754 /docs/extensions/definition_lists.md
parent9fd4a5f1600c96406ad0fb86b1a8287d525972ac (diff)
downloadmarkdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.gz
markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.bz2
markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.zip
Rename docs/*.md => docs/*.txt
The documentation uses features of Python-Markdown that are not supported on GitHub and it's better to get a source view of the docs anyway. For example, that way comments and bug reports can reference a specific line of a file. Of course, it makes sense for Github to render the README, so that is left with the `.md` file extension.
Diffstat (limited to 'docs/extensions/definition_lists.md')
-rw-r--r--docs/extensions/definition_lists.md61
1 files changed, 0 insertions, 61 deletions
diff --git a/docs/extensions/definition_lists.md b/docs/extensions/definition_lists.md
deleted file mode 100644
index 53f14a0..0000000
--- a/docs/extensions/definition_lists.md
+++ /dev/null
@@ -1,61 +0,0 @@
-title: Definition List Extension
-prev_title: Attribute List Extension
-prev_url: attr_list.html
-next_title: Fenced Code Block Extension
-next_url: fenced_code_blocks.html
-
-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