aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/nl2br.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/extensions/nl2br.txt')
-rw-r--r--docs/extensions/nl2br.txt19
1 files changed, 19 insertions, 0 deletions
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/