Convert HTML to markdown.
Project description
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.
- default_title
A boolean to enable setting the title of a link to its href, if no title is given. Defaults to False.
- 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 '*+-'.
- strong_em_symbol
In markdown, both * and _ are used to encode strong or emphasized texts. Either of these symbols can be chosen by the options ASTERISK (default) or UNDERSCORE respectively.
- sub_symbol, sup_symbol
Define the chars that surround <sub> and <sup> text. Defaults to an empty string, because this is non-standard behavior. Could be something like ~ and ^ to result in ~sub~ and ^sup^.
- newline_style
Defines the style of marking linebreaks (<br>) in markdown. The default value SPACES of this option will adopt the usual two spaces and a newline, while BACKSLASH will convert a linebreak to \\n (a backslash an a newline). While the latter convention is non-standard, it is commonly preferred and supported by a lot of interpreters.
Options may be specified as kwargs to the markdownify function, or as a nested Options class in MarkdownConverter subclasses.
Creating Custom Converters
If you have a special usecase that calls for a special conversion, you can always inherit from MarkdownConverter and override the method you want to change:
from markdownify import MarkdownConverter
class ImageBlockConverter(MarkdownConverter):
"""
Create a custom MarkdownConverter that adds two newlines after an image
"""
def convert_img(self, el, text, convert_as_inline):
return super().convert_img(el, text, convert_as_inline) + '\n\n'
# Create shorthand method for conversion
def md(html, **options):
return ImageBlockConverter(**options).convert(html)Development
To run tests:
python setup.py test
To lint:
python setup.py lint
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file markdownify-0.9.3.tar.gz.
File metadata
- Download URL: markdownify-0.9.3.tar.gz
- Upload date:
- Size: 11.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f45b29a7f5eeba304ac4a3e92f38ec516d527d4687b6a621bc44e392bd7f854c |
|
| MD5 | 82194d768260874a3891cd3dad790d47 |
|
| BLAKE2b-256 | c2bbb98b18f01c7c19fe48f19140a487dc6dbc3f7102b64849e9a258c2525efa |
Provenance
File details
Details for the file markdownify-0.9.3-py3-none-any.whl.
File metadata
- Download URL: markdownify-0.9.3-py3-none-any.whl
- Upload date:
- Size: 13.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2408e16a614c14836bcc799e3928af713bb734570a808050eb6e9ac5607579e0 |
|
| MD5 | 9ebbf78098c753e0dd9d9e568ba35d0a |
|
| BLAKE2b-256 | cd283876bfbea1a2f5bec00b274e95f2b503297abbff91670b05d017466dc699 |
