From 8525f57ba7fc10b89c1a679aea1400d258fd0a02 Mon Sep 17 00:00:00 2001
From: Waylan Limberg <waylan@gmail.com>
Date: Tue, 21 Jun 2011 07:57:59 -0400
Subject: Added nl2br extension. Closes #13. Thanks to Brian Neal for writing
 the code and allowing us to use it.

---
 docs/extensions/nl2br.txt | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 docs/extensions/nl2br.txt

(limited to 'docs/extensions/nl2br.txt')

diff --git a/docs/extensions/nl2br.txt b/docs/extensions/nl2br.txt
new file mode 100644
index 0000000..27030f7
--- /dev/null
+++ b/docs/extensions/nl2br.txt
@@ -0,0 +1,19 @@
+NL2BR Extension
+===============
+
+A Python-Markdown extension to treat newlines as hard breaks; like
+StackOverflow and [GitHub][] flavored Markdown do.
+
+Usage:
+
+    >>> import markdown
+    >>> text = """
+    ... Line 1
+    ... Line 2
+    ... """
+    >>> html = markdown.markdown(text, extensions=['nl2br'])
+    >>> print html
+    <p>Line 1<br />
+    Line 2</p>
+
+[Github]: http://github.github.com/github-flavored-markdown/
-- 
cgit v1.2.3