aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDmitry Shachnev <mitya57@gmail.com>2013-07-26 09:16:38 +0400
committerDmitry Shachnev <mitya57@gmail.com>2013-07-26 09:16:38 +0400
commita23ba4d248ab30bc790bfb6f1af53c77d8f6065f (patch)
treeb1b506ab9735d6b7cad8dbeb691a04997654e114 /docs
parent61066d49189b156a54778b7ef70dfd0a3ed86e93 (diff)
downloadmarkdown-a23ba4d248ab30bc790bfb6f1af53c77d8f6065f.tar.gz
markdown-a23ba4d248ab30bc790bfb6f1af53c77d8f6065f.tar.bz2
markdown-a23ba4d248ab30bc790bfb6f1af53c77d8f6065f.zip
Add documentation for smarty extension
Diffstat (limited to 'docs')
-rw-r--r--docs/extensions/index.txt2
-rw-r--r--docs/extensions/sane_lists.txt4
-rw-r--r--docs/extensions/smarty.txt56
-rw-r--r--docs/extensions/toc.txt4
-rw-r--r--docs/siteindex.txt1
5 files changed, 63 insertions, 4 deletions
diff --git a/docs/extensions/index.txt b/docs/extensions/index.txt
index 2137a22..b71c2ec 100644
--- a/docs/extensions/index.txt
+++ b/docs/extensions/index.txt
@@ -53,6 +53,7 @@ Extension | "Name"
[Meta-Data] | `meta`
[New Line to Break] | `nl2br`
[Sane Lists] | `sane_lists`
+[SmartyPants] | `smarty`
[Table of Contents] | `toc`
[WikiLinks] | `wikilinks`
@@ -70,6 +71,7 @@ Extension | "Name"
[Meta-Data]: meta_data.html
[New Line to Break]: nl2br.html
[Sane Lists]: sane_lists.html
+[SmartyPants]: smarty.html
[Table of Contents]: toc.html
[WikiLinks]: wikilinks.html
diff --git a/docs/extensions/sane_lists.txt b/docs/extensions/sane_lists.txt
index 4d24d17..7e67e1f 100644
--- a/docs/extensions/sane_lists.txt
+++ b/docs/extensions/sane_lists.txt
@@ -1,8 +1,8 @@
title: Sane Lists Extension
prev_title: New Line to Break Extension
prev_url: nl2br.html
-next_title: Table of Contents Extension
-next_url: toc.html
+next_title: SmartyPants Extension
+next_url: smarty.html
Sane Lists
==========
diff --git a/docs/extensions/smarty.txt b/docs/extensions/smarty.txt
new file mode 100644
index 0000000..84c6494
--- /dev/null
+++ b/docs/extensions/smarty.txt
@@ -0,0 +1,56 @@
+title: SmartyPants Extension
+prev_title: Sane Lists Extension
+prev_url: sane_lists.html
+next_title: Table of Contents Extension
+next_url: toc.html
+
+SmartyPants
+===========
+
+Summary
+-------
+
+The SmartyPants extension converts ASCII dashes, quotes and ellipses to
+their HTML entity equivalents.
+
+ASCII symbol | Unicode replacements
+------------ | --------------------
+&#39; | &lsquo; &rsquo;
+&quot; | &ldquo; &rdquo;
+\... | &hellip;
+\-- | &ndash;
+-\-- | &mdash;
+
+Arguments
+---------
+
+All three arguments are set to `True` by default.
+
+Argument | Description
+-------- | -----------
+`smart_dashes` | whether to convert dashes
+`smart_quotes` | whether to convert quotes
+`smart_ellipses` | whether to convert ellipses
+
+Usage
+-----
+
+Default configuration:
+
+ >>> html = markdown.markdown(text,
+ ... extensions=['smarty']
+ ... )
+
+Disable quotes convertation:
+
+ >>> html = markdown.markdown(text,
+ ... extensions=['smarty(smart_quotes=False)']
+ ... )
+
+Further reading
+---------------
+
+SmartyPants extension is based on the original SmartyPants implementation
+by John Gruber. Please read it's [documentation][1] for details.
+
+[1]: http://daringfireball.net/projects/smartypants/
diff --git a/docs/extensions/toc.txt b/docs/extensions/toc.txt
index af282c6..2a91bb6 100644
--- a/docs/extensions/toc.txt
+++ b/docs/extensions/toc.txt
@@ -1,6 +1,6 @@
title: Table of Contents Extension
-prev_title: Sane Lists Extension
-prev_url: sane_lists.html
+prev_title: SmartyPants Extension
+prev_url: smarty.html
next_title: Wikilinks Extension
next_url: wikilinks.html
diff --git a/docs/siteindex.txt b/docs/siteindex.txt
index 45fdab2..6846015 100644
--- a/docs/siteindex.txt
+++ b/docs/siteindex.txt
@@ -44,6 +44,7 @@ Table of Contents
* [Meta-Data](extensions/meta_data.html)
* [New Line to Break](extensions/nl2br.html)
* [Sane Lists](extensions/sane_lists.html)
+ * [SmartyPants](extensions/smarty.html)
* [Table of Contents](extensions/toc.html)
* [WikiLinks](extensions/wikilinks.html)
* [Third Party Extensions](extensions/index.html#third-party-extensions)