kostyachum / python-markdown-plain-text

Plain Text Extension for Python Markdown
MIT License
10 stars 4 forks source link

python-markdown-plain-text

Plain Text Extension for Python Markdown

Renders Markdown a document as plain text without a need to render it into HTML and strip all the tags after. This allows you to save some work and dependencies such as Bleach or BeautifulSoup.

Installation

using pip

pip install -e "git+https://github.com/kostyachum/python-markdown-plain-text.git#egg=plain-text-markdown-extention"

Usage

Just use it as an extension

from markdown_plain_text.extention import PlainTextExtension
from markdown import Markdown

...
plain_text = Markdown(extensions=[PlainTextExtension()]).convert(mardown_text)
...

Or use a shortcut method:

from markdown_plain_text.extention import convert_to_plain_text

...
plain_text = convert_to_plain_text(mardown_text)
...

Contribution

  1. Fork and create a branch
  2. pip install .
  3. do the changes
  4. python -m unittest
  5. Create a Pull-Request