访问官网
Github|build| |version| |license| |downloads|
.. |build| image:: https://img.shields.io/github/actions/workflow/status/matthewwithanm/python-markdownify/python-app.yml?branch=develop :alt: GitHub 工作流状态 :target: https://github.com/matthewwithanm/python-markdownify/actions/workflows/python-app.yml?query=workflow%3A%22Python+application%22
.. |version| image:: https://img.shields.io/pypi/v/markdownify :alt: Pypi 版本 :target: https://pypi.org/project/markdownify/
.. |license| image:: https://img.shields.io/pypi/l/markdownify :alt: 许可证 :target: https://github.com/matthewwithanm/python-markdownify/blob/develop/LICENSE
.. |downloads| image:: https://pepy.tech/badge/markdownify :alt: Pypi 下载量 :target: https://pepy.tech/project/markdownify
安装
pip install markdownify
使用方法
将HTML转换为Markdown：
.. code:: python
from markdownify import markdownify as md
md('<b>Yay</b> <a href="http://github.com">GitHub</a>') # > '**Yay** [GitHub](http://github.com)'
指定要排除的标签：
.. code:: python
from markdownify import markdownify as md
md('<b>Yay</b> <a href="http://github.com">GitHub</a>', strip=['a']) # > '**Yay** GitHub'
...或指定要包含的标签：
.. code:: python
from markdownify import markdownify as md
md('<b>Yay</b> <a href="http://github.com">GitHub</a>', convert=['b']) # > '**Yay** GitHub'
选项
Markdownify支持以下选项：
strip
要删除的标签列表。此选项不能与convert选项一起使用。
convert
要转换的标签列表。此选项不能与strip选项一起使用。
autolinks
一个布尔值，指示当a标签的内容与其href匹配时是否应使用"自动链接"样式。默认为True。
default_title
一个布尔值，用于在没有给出标题时将链接的标题设置为其href。默认为False。
heading_style
定义应如何转换标题。接受的值为ATX、ATX_CLOSED、SETEXT和UNDERLINED（是SETEXT的别名）。默认为UNDERLINED。
bullets
一个可迭代对象（字符串、列表或元组），用于定义项目符号样式。如果可迭代对象只包含一个项目，无论列表嵌套多深都将使用它。否则，项目符号将根据嵌套级别交替使用。默认为'*+-'。
strong_em_symbol
在markdown中，*和_都用于编码粗体或斜体文本。可以通过选项ASTERISK（默认）或UNDERSCORE来选择这些符号中的任意一个。
sub_symbol, sup_symbol
定义包围<sub>和<sup>文本的字符。默认为空字符串，因为这是非标准行为。可以是类似~和^的内容，以生成~sub~和^sup^。如果值以<开头并以>结尾，则将其视为HTML标签，并在文本之后使用的字符串中的<后插入/；这允许指定<sub>以在输出中为下标使用原始HTML。
newline_style
定义在markdown中标记换行符（<br>）的样式。此选项的默认值SPACES将采用通常的两个空格和一个换行符，而BACKSLASH将把换行符转换为\\n（反斜杠和换行符）。虽然后一种约定是非标准的，但它通常更受欢迎，并得到许多解释器的支持。
code_language
定义应假定所有<pre>部分使用的语言。如果页面上的所有代码都使用相同的编程语言并应标注为`````python或类似内容，这将很有用。默认为''``（空字符串），可以是任何字符串。
code_language_callback
当HTML代码包含以某种方式提供代码语言的pre标签时（例如作为类），可以使用此回调来从标签中提取语言并将其前缀到转换后的pre标签。回调接收一个BeautifylSoup对象作为参数，并返回一个包含代码语言的字符串，或None。使用类名作为代码语言的示例可能是::
def callback(el):
return el['class'][0] if el.has_attr('class') else None
默认为None。
escape_asterisks
如果设置为False，不会在文本中将*转义为\*。默认为True。
escape_underscores
如果设置为False，不会在文本中将_转义为\_。默认为True。
escape_misc
如果设置为False，不会在文本中转义有时在Markdown中具有特殊意义的其他标点符号。默认为True。
keep_inline_images_in
当图像位于标题或表格单元格内时，图像会转换为其替代文本。如果某些内联图像应该转换为markdown图像，可以将此选项设置为允许包含内联图像的父标签列表，例如['td']。默认为空列表。
wrap, wrap_width
如果wrap设置为True，所有文本段落将在wrap_width字符处换行。默认为False和80。与newline_style=BACKSLASH一起使用可保留段落中的换行符。
选项可以作为kwargs传递给markdownify函数，或作为MarkdownConverter子类中的嵌套Options类。
转换BeautifulSoup对象
.. code:: python
from markdownify import MarkdownConverter
# 创建转换的简写方法
def md(soup, **options):
return MarkdownConverter(**options).convert_soup(soup)
创建自定义转换器
如果你有需要特殊转换的特殊用例，你可以随时继承MarkdownConverter并重写你想要更改的方法。
处理名为abc的HTML标签的函数称为convert_abc(self, el, text, convert_as_inline)，并返回一个包含转换后的HTML标签的字符串。
MarkdownConverter对象将根据函数名处理转换：
.. code:: python
from markdownify import MarkdownConverter
class ImageBlockConverter(MarkdownConverter):
"""
创建一个自定义MarkdownConverter，在图像后添加两个换行符
"""
def convert_img(self, el, text, convert_as_inline):
return super().convert_img(el, text, convert_as_inline) + '\n\n'
# 创建转换的简写方法
def md(html, **options):
return ImageBlockConverter(**options).convert(html)
.. code:: python
from markdownify import MarkdownConverter
class IgnoreParagraphsConverter(MarkdownConverter):
"""
创建一个忽略段落的自定义MarkdownConverter
"""
def convert_p(self, el, text, convert_as_inline):
return ''
# 创建转换的简写方法
def md(html, **options):
return IgnoreParagraphsConverter(**options).convert(html)
命令行界面
使用markdownify example.html > example.md或从stdin管道输入（cat example.html | markdownify > example.md）。
调用markdownify -h查看所有可用选项。
它们与上面列出的选项相同，并接受相同的参数。
开发
要运行测试和代码检查，首先运行pip install tox，然后运行tox。
