aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/nl2br.txt
diff options
context:
space:
mode:
authorJakub Klinkovský <j.l.k@gmx.com>2014-02-15 19:33:21 +0100
committerJakub Klinkovský <j.l.k@gmx.com>2014-02-15 19:33:21 +0100
commit587227a7d8751f4796196a18b7614612e4136da9 (patch)
treeadc4fd9d042141e8ff3996dfe97c20aae91b06b0 /docs/extensions/nl2br.txt
parentd3f93cbfe85387d449af28f2adbdddf8d0873011 (diff)
downloadmarkdown-587227a7d8751f4796196a18b7614612e4136da9.tar.gz
markdown-587227a7d8751f4796196a18b7614612e4136da9.tar.bz2
markdown-587227a7d8751f4796196a18b7614612e4136da9.zip
docs: update nl2br documentation
Diffstat (limited to 'docs/extensions/nl2br.txt')
-rw-r--r--docs/extensions/nl2br.txt18
1 files changed, 15 insertions, 3 deletions
diff --git a/docs/extensions/nl2br.txt b/docs/extensions/nl2br.txt
index ef479fd..1ae8b0b 100644
--- a/docs/extensions/nl2br.txt
+++ b/docs/extensions/nl2br.txt
@@ -7,10 +7,16 @@ next_url: sane_lists.html
NL2BR Extension
===============
-A Python-Markdown extension to treat newlines as hard breaks; like
+Summary
+-------
+
+The NL2BR Extension will cause newlines to be treated as hard breaks; like
StackOverflow and [GitHub][] flavored Markdown do.
-Usage:
+[Github]: http://github.github.com/github-flavored-markdown/
+
+Example
+-------
>>> import markdown
>>> text = """
@@ -22,4 +28,10 @@ Usage:
<p>Line 1<br />
Line 2</p>
-[Github]: http://github.github.com/github-flavored-markdown/
+Usage
+-----
+
+See [Extensions](./index.html) for general extension usage, specify `nl2br`
+as the name of the extension.
+
+This extension does not accept any special configuration options.