Skip to content
Convert HTML to Markdown
Branch: develop
Clone or download
matthewwithanm Merge pull request #11 from AlexVonB/AlexVonB-patch-1
Add newline before and after a markdown list
Latest commit 89d14f4 Jul 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
markdownify Add newline before and after a markdown list Jul 4, 2019
tests added tests for #11 Jul 4, 2019
.gitignore Add gitignore Jul 31, 2013
LICENSE Adding MIT license file Oct 17, 2018
MANIFEST.in Add manifest template Jul 31, 2013
README.rst Document options Aug 1, 2013
setup.cfg Add lint command Jul 31, 2013
setup.py updating classifer to mit license Jun 19, 2019

README.rst

Installation

pip install markdownify

Usage

Convert some HTML to Markdown:

from markdownify import markdownify as md
md('<b>Yay</b> <a href="http://github.com">GitHub</a>')  # > '**Yay** [GitHub](http://github.com)'

Specify tags to exclude (blacklist):

from markdownify import markdownify as md
md('<b>Yay</b> <a href="http://github.com">GitHub</a>', strip=['a'])  # > '**Yay** GitHub'

...or specify the tags you want to include (whitelist):

from markdownify import markdownify as md
md('<b>Yay</b> <a href="http://github.com">GitHub</a>', convert=['b'])  # > '**Yay** GitHub'

Options

Markdownify supports the following options:

strip
A list of tags to strip (blacklist). This option can't be used with the convert option.
convert
A list of tags to convert (whitelist). This option can't be used with the strip option.
autolinks
A boolean indicating whether the "automatic link" style should be used when a a tag's contents match its href. Defaults to True
heading_style
Defines how headings should be converted. Accepted values are ATX, ATX_CLOSED, SETEXT, and UNDERLINED (which is an alias for SETEXT). Defaults to UNDERLINED.
bullets
An iterable (string, list, or tuple) of bullet styles to be used. If the iterable only contains one item, it will be used regardless of how deeply lists are nested. Otherwise, the bullet will alternate based on nesting level. Defaults to '*+-'.

Options may be specified as kwargs to the markdownify function, or as a nested Options class in MarkdownConverter subclasses.

Development

To run tests:

python setup.py test

To lint:

python setup.py lint

You can’t perform that action at this time.