Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

TEMPORARY fork, Convert HTML to markdown.

Project description

This is a temporary fork of the [official markdownify](https://github.com/matthewwithanm/python-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](https://github.com/matthewwithanm/python-markdownify/pull/1) is merged and a new version is released, this package will be deleted.

Installation

pip install will-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

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
will-markdownify-0.4.1.tar.gz (6.3 kB) Copy SHA256 hash SHA256 Source None Nov 12, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page