aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/abbreviations.txt
diff options
context:
space:
mode:
authorJakub Klinkovský <j.l.k@gmx.com>2014-02-15 18:44:53 +0100
committerJakub Klinkovský <j.l.k@gmx.com>2014-02-15 18:44:53 +0100
commit045ef787b7019343f22dfede01fedf38181ad662 (patch)
tree9173f0e3c232adef6139992afd683c0ba2ccb2a2 /docs/extensions/abbreviations.txt
parentfefe904ca9175ab390a8a0868e810a41945cdd8f (diff)
downloadmarkdown-045ef787b7019343f22dfede01fedf38181ad662.tar.gz
markdown-045ef787b7019343f22dfede01fedf38181ad662.tar.bz2
markdown-045ef787b7019343f22dfede01fedf38181ad662.zip
docs: improved documentation of the extra/ extensions
Simplified, unified style, added some undocumented options. NOTE: Footnotes/UNIQUE_IDS stays mostly undocumented
Diffstat (limited to 'docs/extensions/abbreviations.txt')
-rw-r--r--docs/extensions/abbreviations.txt24
1 files changed, 5 insertions, 19 deletions
diff --git a/docs/extensions/abbreviations.txt b/docs/extensions/abbreviations.txt
index 21d90bf..e4c62f6 100644
--- a/docs/extensions/abbreviations.txt
+++ b/docs/extensions/abbreviations.txt
@@ -10,7 +10,7 @@ Abbreviations
Summary
-------
-The Markdown Abbreviation Extension adds the ability to define abbreviations.
+The Abbreviation Extension adds the ability to define abbreviations.
Specifically, any defined abbreviation is wrapped in an `<abbr>` tag.
The Abbreviation extension is included in the standard Markdown library.
@@ -31,7 +31,7 @@ Thus, the following text (taken from the above referenced PHP documentation):
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
-will be rendered like so:
+will be rendered as:
<p>The <abbr title="Hyper Text Markup Language">HTML</abbr> specification
is maintained by the <abbr title="World Wide Web Consortium">W3C</abbr>.</p>
@@ -39,21 +39,7 @@ will be rendered like so:
Usage
-----
-From the Python interpreter:
+See [Extensions](./index.html) for general extension usage, specify `abbr`
+as the name of the extension.
- >>> import markdown
- >>> text = """
- ... Some text with an ABBR.
- ...
- ... *[ABBR]: Abbreviation
- ... """
- >>> html = markdown.markdown(text, ['abbr'])
-
-To use with other extensions, just add them to the list, like this:
-
- >>> html = markdown.markdown(text, ['abbr', 'footnotes'])
-
-Abbreviations can also be called from the command line using Markdown's `-x`
-parameter, like so:
-
- python -m markdown -x abbr source.txt > output.html
+This extension does not accept any special configuration options.