aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/extensions/index.txt19
-rw-r--r--docs/extensions/nl2br.txt19
2 files changed, 21 insertions, 17 deletions
diff --git a/docs/extensions/index.txt b/docs/extensions/index.txt
index 71d857c..6f43519 100644
--- a/docs/extensions/index.txt
+++ b/docs/extensions/index.txt
@@ -17,28 +17,13 @@ available to you.
* [[Footnotes]]
* [[HeaderId]]
* [[Tables]]
+* [[attr_list]]
* [[CodeHilite]]
* [[HTML_Tidy]]
* [[ImageLinks]]
* [[Meta-Data]]
+* [[nl2br]]
* [[RSS]]
* [[Table_of_Contents]]
* [[WikiLinks]]
-Unofficially Supported Extensions
----------------------------------
-
-These extensions have not yet been included in any official Python-Markdown
-release. However, the code is maintained in the projects
-[mainline git repository](http://gitorious.org/projects/python-markdown/repos/mainline)
-by the Python-Markdown developers and the official documentation is maintained
-here. All bug reports should be made to the project. It is anticipated that
-these extensions will be included with some future official release, at which
-time they will be moved to the above list of official extensions.
-
-* [[Legacy]]
-
-
-
-
-
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/