• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1RSS
2===
3
4Summary
5-------
6
7An extension to Python-Markdown that outputs a markdown document as RSS. This
8extension has been included with Python-Markdown since 1.7 and should be
9available to anyone who has a typical install of Python-Markdown.
10
11Usage
12-----
13
14From the Python interpreter:
15
16    >>> import markdown
17    >>> text = "Some markdown document."
18    >>> rss = markdown.markdown(text, ['rss'])
19
20Configuring the Output
21----------------------
22
23An RSS document includes some data about the document (URI, author, title) that
24will likely need to be configured for your needs. Therefore, three configuration
25options are available:
26
27* **URL** : The Main URL for the document.
28* **CREATOR** : The Feed creator's name.
29* **TITLE** : The title for the feed.
30
31An example:
32
33    >>> rss = markdown.markdown(text, extensions = \
34    ...        ['rss(URL=http://example.com,CREATOR=JOHN DOE,TITLE=My Document)']
35    ... )
36