aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2011-06-07 10:48:55 -0400
committerWaylan Limberg <waylan@gmail.com>2011-06-07 10:48:55 -0400
commit11124d9f8ddd547c93078dcf6380deacec7fc32f (patch)
treefd6279145e7dae3ef02505c8ffd74ac0d106fcf0 /docs/extensions
parentbca0d6bf8b26707431c936ed51419358b9e57749 (diff)
downloadmarkdown-11124d9f8ddd547c93078dcf6380deacec7fc32f.tar.gz
markdown-11124d9f8ddd547c93078dcf6380deacec7fc32f.tar.bz2
markdown-11124d9f8ddd547c93078dcf6380deacec7fc32f.zip
Added smart_strong extension. Fixes Issue #17. Like PHP Markdown Extra, we now include smart handling of double underscores (not just single underscores). The new behavior may be called seperately as the 'smart_strong' extension or as part of the 'extra' extension.
Diffstat (limited to 'docs/extensions')
-rw-r--r--docs/extensions/Smart_Strong.txt30
-rw-r--r--docs/extensions/extra.txt1
2 files changed, 31 insertions, 0 deletions
diff --git a/docs/extensions/Smart_Strong.txt b/docs/extensions/Smart_Strong.txt
new file mode 100644
index 0000000..c939016
--- /dev/null
+++ b/docs/extensions/Smart_Strong.txt
@@ -0,0 +1,30 @@
+Smart_Strong
+------------
+
+Summary
+
+The Markdown Smart_Strong Extension adds smarter handling of double underscores
+within words. This does for double underscores what 'smart_emphasis' does for
+single underscores.
+
+The Smart_Strong Extension is included in the standard Markdown library.
+
+Usage
+-----
+
+ >>> import markdown
+ >>> markdown.markdown('Text with double__underscore__words.', \
+ extensions=['smart_strong'])
+ u'<p>Text with double__underscore__words.</p>'
+ >>> markdown.markdown('__Strong__ still works.', \
+ extensions=['smart_strong'])
+ u'<p><strong>Strong</strong> still works.</p>'
+ >>> markdown.markdown('__this__works__too__.', \
+ extensions=['smart_strong'])
+ u'<p><strong>this__works__too</strong>.</p>'
+
+This extension is also included with the [[Extra]] Extension. You may call that
+extension to get this behavior with all the other features of 'Extra'.
+
+ >>> markdown.markdown(text, extensions=['extra'])
+
diff --git a/docs/extensions/extra.txt b/docs/extensions/extra.txt
index 817d58f..018a849 100644
--- a/docs/extensions/extra.txt
+++ b/docs/extensions/extra.txt
@@ -15,6 +15,7 @@ The supported extensions include:
* [[Footnotes]]
* [[HeaderId]]
* [[Tables]]
+* [[Smart_Strong]]
See each individual extension for syntax documentation. Extra and all it's
supported extensions are included in the standard Markdown library.