Skip to main content

TEMPORARY fork, Convert HTML to markdown.

Project description

This is a temporary fork of the [official markdownify]( repo to add Python 3 support, and allow pip to keep working with the behavior changes with the –process-dependency-links deprecation.

Once [the python 3 pull request]( is merged and a new version is released, this package will be deleted.


pip install will-markdownify


Convert some HTML to Markdown:

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

Specify tags to exclude (blacklist):

from markdownify import markdownify as md
md('<b>Yay</b> <a href="">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="">GitHub</a>', convert=['b'])  # > '**Yay** GitHub'


Markdownify supports the following options:

A list of tags to strip (blacklist). This option can’t be used with the convert option.
A list of tags to convert (whitelist). This option can’t be used with the strip option.
A boolean indicating whether the “automatic link” style should be used when a a tag’s contents match its href. Defaults to True
Defines how headings should be converted. Accepted values are ATX, ATX_CLOSED, SETEXT, and UNDERLINED (which is an alias for SETEXT). Defaults to UNDERLINED.
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.


To run tests:

python test

To lint:

python lint

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for will-markdownify, version 0.4.1
Filename, size File type Python version Upload date Hashes
Filename, size will-markdownify-0.4.1.tar.gz (6.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page