aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/CHANGE_LOG4
-rw-r--r--docs/extensions/index.md1
-rw-r--r--docs/extensions/sane_lists.md75
-rw-r--r--docs/release-2.1.0.md9
-rw-r--r--docs/release-2.1.1.md7
5 files changed, 90 insertions, 6 deletions
diff --git a/docs/CHANGE_LOG b/docs/CHANGE_LOG
index e005ff8..750c9d7 100644
--- a/docs/CHANGE_LOG
+++ b/docs/CHANGE_LOG
@@ -1,6 +1,10 @@
PYTHON MARKDOWN CHANGELOG
=========================
+Nov 24, 2011: Released version 2.1.0-Final.
+
+Oct 7, 2009: Released version 2.0.3-Final.
+
Sept 28, 2009: Released version 2.0.2-Final.
May 20, 2009: Released version 2.0.1-Final.
diff --git a/docs/extensions/index.md b/docs/extensions/index.md
index 7ab2414..82f00a4 100644
--- a/docs/extensions/index.md
+++ b/docs/extensions/index.md
@@ -40,6 +40,7 @@ available to you.
* [Meta-Data](meta_data.html)
* [New Line to Break](nl2br.html)
* [RSS](rss.html)
+* [Sane Lists](sane_lists.html)
* [Table of Contents](toc.html)
* [WikiLinks](wikilinks.html)
diff --git a/docs/extensions/sane_lists.md b/docs/extensions/sane_lists.md
new file mode 100644
index 0000000..b1c1d06
--- /dev/null
+++ b/docs/extensions/sane_lists.md
@@ -0,0 +1,75 @@
+Sane Lists
+----------
+
+Summary
+-------
+
+The Sane Lists Extension alters the behavior of the Markdown List syntax
+to be less surprising.
+
+This extension is included in the standard Markdown library.
+
+Syntax
+------
+
+Sane Lists do not allow the mixing of list types. In other words, an ordered
+list will not continue when an unordered list item is encountered and
+vice versa. For example:
+
+ 1. Ordered item 1
+ 2. Ordered item 2
+
+ * Unordered item 1
+ * Unordered item 2
+
+will result in the following output:
+
+ <ol>
+ <li>Ordered item 1</li>
+ <li>Ordered item 2</li>
+ </ol>
+
+ <ul>
+ <li>Unordered item 1</li>
+ <li>Unordered item 2</li>
+ </ul>
+
+Whereas the default Markdown behavior would be to generate an unordered list.
+
+Note that, unlike the default Markdown behavior, if a blank line is not
+included between list items, the different list type is ignored completely.
+This corresponds to the behavior of paragraphs. For example:
+
+ A Paragraph.
+ * Not a list item.
+
+ 1. Ordered list item.
+ * Not a separate list item.
+
+With this extension the above will result in the following output:
+
+ <p>A Paragraph.
+ * Not a list item.</p>
+
+ <ol>
+ <li>Ordered list item.
+ * Not a separate list item.</li>
+ </ol>
+
+In all other ways, Sane Lists should behave as normal Markdown lists.
+
+Usage
+-----
+
+From the Python interpreter:
+
+ >>> html = markdown.markdown(text, ['sane_lists'])
+
+To use with other extensions, just add them to the list, like this:
+
+ >>> html = markdown.markdown(text, ['def_list', 'sane_lists'])
+
+The extension can also be called from the command line using Markdown's `-x`
+parameter:
+
+ python -m markdown -x sane_lists source.txt > output.html
diff --git a/docs/release-2.1.0.md b/docs/release-2.1.0.md
index fdfee9b..f6c203b 100644
--- a/docs/release-2.1.0.md
+++ b/docs/release-2.1.0.md
@@ -1,15 +1,12 @@
-Python-Markdown 2.1.0-Beta Release Notes
-========================================
+Python-Markdown 2.1.0 Release Notes
+===================================
-We are pleased to release Python-Markdown 2.1-Beta which makes many
+We are pleased to release Python-Markdown 2.1 which makes many
improvements on 2.0. In fact, we consider 2.1 to be what 2.0 should have been.
While 2.1 consists mostly of bug fixes, bringing Python-Markdown more inline
with other implementations, some internal improvements were made to the parser,
a few new builtin extensions were added, and HTML5 support was added.
-Please be aware that Python-Markdown 2.1-Beta is *beta* software and is not
-considered production ready pending the release of 2.1-Final.
-
Python-Markdown supports Python versions 2.4, 2.5, 2.6, 2.7, 3.1, and 3.2 out
of the box. In fact, the same codebase installs on Python 3.1 and 3.2 with no
extra work by the end user.
diff --git a/docs/release-2.1.1.md b/docs/release-2.1.1.md
new file mode 100644
index 0000000..9e1bcab
--- /dev/null
+++ b/docs/release-2.1.1.md
@@ -0,0 +1,7 @@
+Python-Markdown 2.1.1 Release Notes
+===================================
+
+Python-Markdown 2.1.1 is a bug-fix release. No new features have been added.
+Most notably, a bug which caused raw HTML paring to run __very__ slowly has
+been fixed along with a few bugs which caused the parser to raise exceptions
+while parsing. For a full list of changes, see the git log.