diff options
Diffstat (limited to 'docs/extensions/nl2br.md')
-rw-r--r-- | docs/extensions/nl2br.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/extensions/nl2br.md b/docs/extensions/nl2br.md new file mode 100644 index 0000000..4f5e611 --- /dev/null +++ b/docs/extensions/nl2br.md @@ -0,0 +1,35 @@ +title: New Line to Break Extension + +New-Line-to-Break Extension +=========================== + +Summary +------- + +The New-Line-to-Break (`nl2b`) Extension will cause newlines to be treated as +hard breaks; like StackOverflow and [GitHub][] flavored Markdown do. + +[Github]: http://github.github.com/github-flavored-markdown/ + +Example +------- + +```pycon +>>> import markdown +>>> text = """ +... Line 1 +... Line 2 +... """ +>>> html = markdown.markdown(text, extensions=['markdown.extensions.nl2br']) +>>> print html +<p>Line 1<br /> +Line 2</p> +``` + +Usage +----- + +See [Extensions](index.md) for general extension usage, specify +`markdown.extensions.nl2br` as the name of the extension. + +This extension does not accept any special configuration options. |