diff options
| author | Waylan Limberg <waylan@gmail.com> | 2014-02-16 08:53:16 -0500 |
|---|---|---|
| committer | Waylan Limberg <waylan@gmail.com> | 2014-02-16 08:53:16 -0500 |
| commit | 9a03243ff51ce2e868cfd2de713d7de6ae84140e (patch) | |
| tree | 9c81612ef756024dd205022d250fc65e2e11eb3a /docs/extensions/nl2br.txt | |
| parent | fefe904ca9175ab390a8a0868e810a41945cdd8f (diff) | |
| parent | aff7cabd5fa16daff866c06e056804d3f6f42500 (diff) | |
| download | markdown-9a03243ff51ce2e868cfd2de713d7de6ae84140e.tar.gz markdown-9a03243ff51ce2e868cfd2de713d7de6ae84140e.tar.bz2 markdown-9a03243ff51ce2e868cfd2de713d7de6ae84140e.zip | |
Merge pull request #288 from lahwaacz/master
docs: improved documentation
Diffstat (limited to 'docs/extensions/nl2br.txt')
| -rw-r--r-- | docs/extensions/nl2br.txt | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/docs/extensions/nl2br.txt b/docs/extensions/nl2br.txt index ef479fd..0fe20c3 100644 --- a/docs/extensions/nl2br.txt +++ b/docs/extensions/nl2br.txt @@ -4,13 +4,19 @@ prev_url: meta_data.html next_title: Sane Lists Extension next_url: sane_lists.html -NL2BR Extension -=============== +NL2BR +===== -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. |