aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/nl2br.txt
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2012-03-07 09:35:40 -0500
committerWaylan Limberg <waylan@gmail.com>2012-03-07 09:35:40 -0500
commitec46692cf5c4d5e22950bc8e7d14cb0ec327fb87 (patch)
tree9c1b9c5025948204e415a21938469bf50bbae754 /docs/extensions/nl2br.txt
parent9fd4a5f1600c96406ad0fb86b1a8287d525972ac (diff)
downloadmarkdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.gz
markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.tar.bz2
markdown-ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87.zip
Rename docs/*.md => docs/*.txt
The documentation uses features of Python-Markdown that are not supported on GitHub and it's better to get a source view of the docs anyway. For example, that way comments and bug reports can reference a specific line of a file. Of course, it makes sense for Github to render the README, so that is left with the `.md` file extension.
Diffstat (limited to 'docs/extensions/nl2br.txt')
-rw-r--r--docs/extensions/nl2br.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/extensions/nl2br.txt b/docs/extensions/nl2br.txt
new file mode 100644
index 0000000..affd8ee
--- /dev/null
+++ b/docs/extensions/nl2br.txt
@@ -0,0 +1,25 @@
+title: New Line to Break Extension
+prev_title: Meta-Data Extension
+prev_url: meta_data.html
+next_title: RSS Extension
+next_url: rss.html
+
+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/