diff options
Diffstat (limited to 'docs/extensions/rss.txt')
| -rw-r--r-- | docs/extensions/rss.txt | 41 |
1 files changed, 0 insertions, 41 deletions
diff --git a/docs/extensions/rss.txt b/docs/extensions/rss.txt deleted file mode 100644 index 67e6d96..0000000 --- a/docs/extensions/rss.txt +++ /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)'] - ... ) |