Metadata-Version: 2.1
Name: markdown-smartbreaks
Version: 1.0.0
Home-page: https://github.com/zetaloop/markdown_smartbreaks
Author: zetaloop
Author-email: zetaloop@outlook.com
License: MIT
Keywords: markdown nl2br breaks
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Text Processing :: Markup :: HTML
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Markdown >=3.0.1

# Markdown SmartBreaks

A slightly better `nl2br` extension for Python Markdown.

## Whats different?
- Won't break for html tags. (e.g. code blocks)

## Installation

``` bash
pip install markdown-smartbreaks
```

## Usage

### Markdown module
``` python
import markdown
import smartbreaks

data = markdown.markdown(
    md,
    extensions=[
        smartbreaks.SmartBreaksExtension()
    ]
)
```

### MkDocs `mkdocs.yml`
``` yaml
markdown_extensions:
  - smartbreaks
```

## License

Licensed under the MIT License.
