[319]使用python将markdown和html互转

周小董

已于 2024-09-02 09:13:32 修改

阅读量5.1k

点赞数 1

分类专栏： Python前行者文章标签： python

于 2018-07-12 09:06:34 首次发布

本文链接：https://blog.csdn.net/xc_zhou/article/details/81009902

版权

Python前行者专栏收录该内容

328 篇文章 87 订阅

订阅专栏

文章目录

将markdown转换成html

Github地址：https://github.com/Python-Markdown/markdown

什么是Python-Markdown？

Python-Markdown是一个用于解析和转换Markdown文档的Python库。它可以将Markdown文本转换为HTML或其他格式，并提供了一些方便的工具和扩展来扩展Markdown的功能。Python-Markdown的目标是提供一种灵活而易于使用的方式来处理和生成Markdown文档，可以专注于内容而不必担心文档的样式和排版。

Python-Markdown的特点

标准Markdown支持：它支持标准Markdown语法，包括标题、段落、列表、链接、引用等。
HTML转换：Python-Markdown可以将Markdown文本转换为HTML，可以在网页上轻松显示文档。
自定义扩展：可以使用扩展来添加自定义的Markdown标记和功能，以满足不同的需求。
多输出格式：除了HTML，Python-Markdown还支持将Markdown文档转换为其他格式，如PDF、LaTeX等。

安装Python-Markdown

要开始使用Python-Markdown，首先需要安装它。可以使用pip来安装Python-Markdown：

pip install markdown

安装完成后，就可以在Python中导入markdown模块，并开始解析和转换Markdown文档了。

使用Python-Markdown

基本用法

首先看一下如何使用Python-Markdown来解析和转换Markdown文档。

以下是一个简单的示例代码，演示了如何将Markdown文本转换为HTML：

import markdown

# Markdown文本
markdown_text = """
# 标题
这是一个Markdown文档的示例。

- 列表项1
- 列表项2

[链接](https://www.example.com)
"""

# 转换Markdown为HTML
html = markdown.markdown(markdown_text)

# 打印HTML
print(html)

运行这段代码后，将获得Markdown文本转换后的HTML内容，并将其打印出来。可以将这段HTML嵌入到网页中，以显示Markdown内容。

命令行下使用markdown_py脚本进行转换：

markdown_py README.md >> README.html

自定义扩展

Python-Markdown支持自定义扩展，可以根据需求添加额外的Markdown标记和功能。

以下是一个示例，演示了如何创建一个简单的自定义扩展，以将文本中的emoji表情符号转换为图像：

import markdown
from markdown.extensions import Extension
from markdown.inlinepatterns import SimpleTagPattern

# 自定义扩展类
class EmojiExtension(Extension):
    def extendMarkdown(self, md):
        emoji_pattern = r':(\w+):'
        emoji_tag = 'img src="emojis/\g<1>.png" alt=":\g<1>:" title=":\g<1>:"'

        emoji_re = SimpleTagPattern(emoji_pattern, 'emoji')
        md.inlinePatterns.add('emoji', emoji_re, '>not_strong')

# Markdown文本
markdown_text = "这是一个示例文本，包含一些表情符号：:smile: :heart: :rocket:"

# 创建Markdown实例并应用自定义扩展
md = markdown.Markdown(extensions=[EmojiExtension()])

# 转换Markdown为HTML
html = md.convert(markdown_text)

# 打印HTML
print(html)

在这个示例中，创建了一个自定义扩展EmojiExtension，它可以将文本中的:smile:等表情符号转换为对应的图像。可以根据需要编写自己的扩展来添加额外的Markdown功能。

使用样式表

如果想为生成的HTML添加自定义样式，可以使用CSS（层叠样式表）。可以创建一个CSS样式表，然后在生成的HTML中引用它，以便自定义Markdown文档的外观。

以下是一个简单的示例，展示了如何为Markdown文档添加自定义样式：

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>Markdown文档</title>
    <link rel="stylesheet" type="text/css" href="custom_styles.css">
</head>
<body>
    <div class="markdown-content">
        <!-- 这里插入Python-Markdown转换后的HTML -->
    </div>


</body>
</html>

在这个示例中，在HTML文档的<head>部分引用了一个名为custom_styles.css的CSS样式表。可以在custom_styles.css中定义自己的样式，例如更改字体、颜色、边框等，以自定义Markdown文档的外观。

多语言支持

Python-Markdown支持多种语言的Markdown标记。如果需要在不同语言中创建Markdown文档，可以在生成HTML时指定不同的语言扩展功能。

例如，如果要处理中文Markdown，可以使用markdown.extensions.extra扩展功能，如下所示：

import markdown
from markdown.extensions.extra import ExtraExtension

# 中文Markdown文本
markdown_text = """
# 标题
这是一个Markdown文档的示例。

- 列表项1
- 列表项2

[链接](https://www.example.com)
"""

# 创建Markdown实例并应用扩展功能
md = markdown.Markdown(extensions=[ExtraExtension()])

# 转换Markdown为HTML
html = md.convert(markdown_text)

# 打印HTML
print(html)

在这个示例中，使用了ExtraExtension扩展功能来处理中文Markdown文档。

将HTML转换为Markdown

文档：https://pypi.org/project/html2text/

安装：

pip install html2text

Option	Description
–version	Show program’s version number and exit
-h, --help	Show this help message and exit
–ignore-links	Don’t include any formatting for links
–escape-all	Escape all special characters. Output is less readable, but avoids corner case formatting issues.
–reference-links	Use reference links instead of links to create markdown
–mark-code	Mark preformatted and code blocks with [code]…[/code]

html2text模块提供了一个名为html2text的函数，可以将HTML转换为Markdown格式的文本。以下是一个示例：

import html2text

html = "<h1>Hello, World!</h1><p>This is an example.</p>"
markdown = html2text.html2text(html)
print(markdown)

自定义转换选项

html2text还提供了一些可自定义的选项，以便根据需要进行转换。以下是一些常用的选项：

bodywidth：指定输出的每行文本的最大宽度。
wrap_links：确定是否在链接周围添加方括号。
skip_internal_links：确定是否跳过内部链接。

这些选项可以通过在html2text函数中传递关键字参数来进行设置。例如：

markdown = html2text.html2text(html, bodywidth=80, wrap_links=True, skip_internal_links=False)

以上代码将设置最大行宽为80，对链接添加方括号，并不跳过内部链接。

处理超链接和图片

在转换HTML到Markdown格式时，还经常遇到处理超链接和图片的需求。html2text模块也提供了相应的解决方案。

超链接

通过设置aliases属性可以自定义链接的显示文本。例如：

html = '<a href="https://www.example.com">Visit our website</a>'
h = html2text.HTML2Text()
h.aliases.update({"https://www.example.com": "Example Website"})
markdown = h.handle(html)
print(markdown)

以上代码将显示为Markdown格式的超链接，并将链接指向的网站显示为自定义文本。

图片
html2text模块同样支持将HTML中的图片转换为Markdown格式。例如：

html = '<img src="image.jpg" alt="Example Image">'
markdown = html2text.html2text(html)
print(markdown)

以上代码将显示为Markdown格式的图片，并将图像文件显示为自定义文本。

示例2

import html2text
 
# 示例HTML内容
html_content = """
<h1>标题</h1>
<p>这是一个段落。</p>
<ul>
<li>列表项1</li>
<li>列表项2</li>
</ul>
"""
# 创建html2text对象
h = html2text.HTML2Text()
# 调用转换方法
markdown_text = h.handle(html_content)
print(markdown_text)

示例3

>>> import html2text
>>>
>>> h = html2text.HTML2Text()
>>> # Ignore converting links from HTML
>>> h.ignore_links = True
>>> print(h.handle("<p>Hello, <a href='http://earth.google.com/'>world</a>!"))
Hello, world!

>>> # Don't Ignore links anymore, I like links
>>> h.ignore_links = False
>>> print(h.handle("<p>Hello, <a href='http://earth.google.com/'>world</a>!"))
Hello, [world](http://earth.google.com/)!

参考：https://blog.csdn.net/wuShiJingZuo/article/details/135336517
https://developer.aliyun.com/article/1503125
https://blog.csdn.net/Young_Pro/article/details/140869210