aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/rss.md
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2012-03-07 09:35:40 -0500
committerWaylan Limberg <waylan@gmail.com>2012-03-07 09:35:40 -0500
commitec46692cf5c4d5e22950bc8e7d14cb0ec327fb87 (patch)
tree9c1b9c5025948204e415a21938469bf50bbae754 /docs/extensions/rss.md
parent9fd4a5f1600c96406ad0fb86b1a8287d525972ac (diff)
downloadmarkdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.gz
markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.bz2
markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.zip
Rename docs/*.md => docs/*.txt
The documentation uses features of Python-Markdown that are not supported on GitHub and it's better to get a source view of the docs anyway. For example, that way comments and bug reports can reference a specific line of a file. Of course, it makes sense for Github to render the README, so that is left with the `.md` file extension.
Diffstat (limited to 'docs/extensions/rss.md')
-rw-r--r--docs/extensions/rss.md41
1 files changed, 0 insertions, 41 deletions
diff --git a/docs/extensions/rss.md b/docs/extensions/rss.md
deleted file mode 100644
index 67e6d96..0000000
--- a/docs/extensions/rss.md
+++ /dev/null
@@ -1,41 +0,0 @@
-title: RSS Extension
-prev_title: New Line to Break Extension
-prev_url: nl2br.html
-next_title: Sane Lists Extension
-next_url: sane_lists.html
-
-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)']
- ... )