blob: 2c7a1a58ec4c8984f420a14c383548301d052958 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
title: New Line to Break Extension
New-Line-to-Break Extension
===========================
Summary
-------
The New-Line-to-Break (`nl2br`) Extension will cause newlines to be treated as
hard breaks; like StackOverflow and [GitHub][] flavored Markdown do.
[Github]: https://github.github.com/github-flavored-markdown/
Example
-------
```pycon
>>> import markdown
>>> text = """
... Line 1
... Line 2
... """
>>> html = markdown.markdown(text, extensions=['nl2br'])
>>> print html
<p>Line 1<br />
Line 2</p>
```
Usage
-----
See [Extensions](index.md) for general extension usage. Use `nl2br` as the name
of the extension.
This extension does not accept any special configuration options.
A trivial example:
```python
markdown.markdown(some_text, extensions=['nl2br'])
```
|
