diff options
author | Waylan Limberg <waylan@gmail.com> | 2014-02-16 08:53:16 -0500 |
---|---|---|
committer | Waylan Limberg <waylan@gmail.com> | 2014-02-16 08:53:16 -0500 |
commit | 9a03243ff51ce2e868cfd2de713d7de6ae84140e (patch) | |
tree | 9c81612ef756024dd205022d250fc65e2e11eb3a /docs/extensions/definition_lists.txt | |
parent | fefe904ca9175ab390a8a0868e810a41945cdd8f (diff) | |
parent | aff7cabd5fa16daff866c06e056804d3f6f42500 (diff) | |
download | markdown-9a03243ff51ce2e868cfd2de713d7de6ae84140e.tar.gz markdown-9a03243ff51ce2e868cfd2de713d7de6ae84140e.tar.bz2 markdown-9a03243ff51ce2e868cfd2de713d7de6ae84140e.zip |
Merge pull request #288 from lahwaacz/master
docs: improved documentation
Diffstat (limited to 'docs/extensions/definition_lists.txt')
-rw-r--r-- | docs/extensions/definition_lists.txt | 24 |
1 files changed, 8 insertions, 16 deletions
diff --git a/docs/extensions/definition_lists.txt b/docs/extensions/definition_lists.txt index a5ba393..31e8601 100644 --- a/docs/extensions/definition_lists.txt +++ b/docs/extensions/definition_lists.txt @@ -1,7 +1,7 @@ -title: Definition List Extension -prev_title: Attribute List Extension +title: Definition Lists Extension +prev_title: Attribute Lists Extension prev_url: attr_list.html -next_title: Fenced Code Block Extension +next_title: Fenced Code Blocks Extension next_url: fenced_code_blocks.html Definition Lists @@ -10,7 +10,7 @@ Definition Lists Summary ------- -The Definition List Extension adds the ability to create definition lists in +The Definition Lists extension adds the ability to create definition lists in Markdown documents. This extension is included in the standard Markdown library. @@ -32,7 +32,7 @@ Thus, the following text (taken from the above referenced PHP documentation): Orange : The fruit of an evergreen tree of the genus Citrus. -will be rendered like so: +will be rendered as: <dl> <dt>Apple</dt> @@ -47,15 +47,7 @@ will be rendered like so: Usage ----- -From the Python interpreter: +See [Extensions](index.html) for general extension usage, specify `def_list` +as the name of the extension. - >>> 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: - - python -m markdown -x def_list source.txt > output.html +This extension does not accept any special configuration options. |