From ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Wed, 7 Mar 2012 09:35:40 -0500 Subject: 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. --- docs/extensions/definition_lists.md | 61 ------------------------------------- 1 file changed, 61 deletions(-) delete mode 100644 docs/extensions/definition_lists.md (limited to 'docs/extensions/definition_lists.md') 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: - -
-
Apple
-
Pomaceous fruit of plants of the genus Malus in - the family Rosaceae.
- -
Orange
-
The fruit of an evergreen tree of the genus Citrus.
-
- - -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 -- cgit v1.2.3