matthewwithanm/python-markdownify

`` 部分假定的语言。如果页面上的所有代码都是同一种编程语言，

并且应该使用 `````python`` 或类似方式进行注释，则此选项很有用。

默认为 ``''``（空字符串），可以是任何字符串。

code_language_callback

当 HTML 代码包含以某种方式提供代码语言的 ``pre`` 标签（例如作为 class）时，

可以使用此回调从标签中提取语言，

并将其作为前缀添加到转换后的 ``pre`` 标签中。

该回调接受一个单一参数，即 BeautifulSoup 对象，并返回

一个包含代码语言的字符串，或者 ``None``。

使用 class 名称作为代码语言的示例如下：


```
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

如果设置为 ``True``，则转义文本中有时在 Markdown 中具有特殊含义的

其他标点符号。

默认为 ``False``。

keep_inline_images_in

当图像位于标题或表格单元格内时，图像将被转换为其 alt 文本。如果某些内联图像应该被转换为 Markdown 图像，则可以将此选项设置为允许包含内联图像的父标签列表，

例如 ``['td']``。

默认为空列表。

table_infer_header

控制没有标题行（由 ```` 或 ```` 指示）的表格的处理方式。当设置为 ``True`` 时，第一个主体行将作为标题行使用。

默认为 ``False``，此时标题行留空。

wrap, wrap_width

如果将 ``wrap`` 设置为 ``True``，所有文本段落将在

``wrap_width`` 字符处换行。默认为 ``False`` 和 ``80``。

与 ``newline_style=BACKSLASH`` 一起使用可保留段落中的换行符。

`wrap_width` 值为 `None` 会将行重排为无限的行长度。

strip_document

控制是否从最终转换的文档中删除开头和/或结尾的分隔换行符。支持的值为 ``LSTRIP``（开头）、

``RSTRIP``（结尾）、``STRIP``（两者）和 ``None``（两者都不）。文档内部的换行符不受影响。

默认为 ``STRIP``。

strip_pre

控制是否从 ``
`` 标签中删除开头/结尾的空行。支持的值为 ``STRIP``（所有开头/结尾的空行）、

``STRIP_ONE``（一行开头/结尾的空行）和 ``None``（两者都不）。

默认为 ``STRIP``。

bs4_options

为用于解析 HTML 标记的 ``BeautifulSoup`` 对象

指定额外的配置选项。字符串和列表值（例如 ``lxml`` 或 ``html5lib``）被视为 ``features`` 参数以控制解析器选择。字典值（例如 ``{"from_encoding": "iso-8859-8"}``）

被视为用于 BeautifulSoup 构造函数的完整 kwargs，

允许指定任何参数。有关参数的详细信息，请参阅

Beautiful Soup 文档：

.. _BeautifulSoup: https://www.crummy.com/software/BeautifulSoup/bs4/doc/

这些选项可以作为 ``markdownify`` 函数的 kwargs 指定，或者作为

``MarkdownConverter`` 子类中嵌套的 ``Options`` 类指定。

# 转换 BeautifulSoup 对象

.. code:: python


```
from markdownify import MarkdownConverter



# 为 conversion 创建 shorthand 方法

def md(soup, **options):

    return MarkdownConverter(**options).convert_soup(soup)
```


# 创建自定义转换器

如果你有一个需要特殊转换的特殊用例，你总是

可以继承 ``MarkdownConverter`` 并重写你想要更改的方法。

处理名为 ``abc`` 的 HTML 标签的函数被称为

``convert_abc(self, el, text, parent_tags)`` 并返回一个包含已转换 HTML 标签的字符串。

``MarkdownConverter`` 对象将根据

函数名称处理转换：

.. code:: python


```
from markdownify import MarkdownConverter



class ImageBlockConverter(MarkdownConverter):

    """

    Create a custom MarkdownConverter that adds two newlines after an image

    """

    def convert_img(self, el, text, parent_tags):

        return super().convert_img(el, text, parent_tags) + '\n\n'



# 为 conversion 创建 shorthand 方法

def md(html, **options):

    return ImageBlockConverter(**options).convert(html)
```


.. code:: python


```
from markdownify import MarkdownConverter



class IgnoreParagraphsConverter(MarkdownConverter):

    """

    Create a custom MarkdownConverter that ignores paragraphs

    """

    def convert_p(self, el, text, parent_tags):

        return ''



# 为 conversion 创建 shorthand 方法

def md(html, **options):

    return IgnoreParagraphsConverter(**options).convert(html)
```


# 命令行界面

使用 ``markdownify example.html > example.md`` 或从 stdin 管道输入

（``cat example.html | markdownify > example.md``）。

调用 ``markdownify -h`` 以查看所有可用选项。

它们与上面列出的相同，并接受相同的参数。

# 开发

要运行测试和 linter，请运行一次 ``pip install tox``，然后运行 ``tox``。