aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/RSS.txt
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2009-03-19 21:35:21 -0400
committerWaylan Limberg <waylan@gmail.com>2009-03-19 21:35:21 -0400
commitc1eb12e10480a60e2fc26a0091cafb779553a4fe (patch)
tree98b0a5cdceb23430c84433f25516796ec3e7ed06 /docs/extensions/RSS.txt
parent70c81659eca814bb037b93c95996210d192e5ca5 (diff)
downloadmarkdown-c1eb12e10480a60e2fc26a0091cafb779553a4fe.tar.gz
markdown-c1eb12e10480a60e2fc26a0091cafb779553a4fe.tar.bz2
markdown-c1eb12e10480a60e2fc26a0091cafb779553a4fe.zip
Added documentation for the rest of the extensions included with the distribution.
Diffstat (limited to 'docs/extensions/RSS.txt')
-rw-r--r--docs/extensions/RSS.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/extensions/RSS.txt b/docs/extensions/RSS.txt
new file mode 100644
index 0000000..f2ecf0c
--- /dev/null
+++ b/docs/extensions/RSS.txt
@@ -0,0 +1,35 @@
+RSS
+===
+
+Summary
+-------
+
+An extension to Python-Markdown that outputs a markdown document as RSS. This
+extension has been included with Python-Markdown since 1.7 and should be
+available to anyone who has a typical install of Python-Markdown.
+
+Usage
+-----
+
+From the Python interpreter:
+
+ >>> import markdown
+ >>> text = "Some markdown document."
+ >>> rss = markdown.markdown(text, ['rss'])
+
+Configuring the Output
+----------------------
+
+An RSS document includes some data about the document (URI, author, title) that
+will likely need to be configured for your needs. Therefore, three configuration
+options are available:
+
+* **URL** : The Main URL for the document.
+* **CREATOR** : The Feed creator's name.
+* **TITLE** : The title for the feed.
+
+An example:
+
+ >>> rss = markdown.markdown(text, extensions = \
+ ... ['rss(URL=http://example.com,CREATOR=JOHN DOE,TITLE=My Document)']
+ ... )