Python-Markdown：从入门到精通 | python小知识

原创

aiweker 2025-02-08 21:46:09 博主文章分类：python小知识 ©著作权

©著作权归作者所有：来自51CTO博客作者aiweker的原创作品，请联系作者获取转载授权，否则将追究法律责任

Python-Markdown：从入门到精通 | python小知识

在当今数字化时代，高效的文本编辑和排版至关重要。Markdown作为一种轻量级标记语言，凭借其简洁的语法和强大的功能，在技术写作、文档编辑、博客撰写等领域广泛应用。本文将深入探讨Markdown的基本语法、Python-Markdown库的主要功能，并通过一个完整的例子展示如何使用该库将Markdown文件转换为HTML，并设置自定义CSS进行美化。

一、Markdown语法与作用

Markdown允许人们使用易读易写的纯文本格式编写文档，其简洁的语法使得文档结构一目了然。Markdown的基本语法包括：

标题：通过在文本前添加不同数量的“#”来实现六级标题。
段落与换行：直接输入文本即可创建段落，段落之间用空行分隔。若需在段落内换行，可在换行处添加两个或多个空格后按回车键。
文本格式：
- 加粗：使用“**”或“__”包裹需加粗的文本。
- 斜体：用“*”或“_”包裹文本实现斜体效果。
- 加粗斜体：将“***”或“___”用于文本两端。
- 删除线：在需要添加删除线的文本前后加上“~~”。
列表：
- 无序列表：使用“-”、“*”或“+”作为列表标记。
- 有序列表：以数字和“.”作为标记。
- 嵌套列表：在列表项内按缩进添加子列表标记。
引用：使用“>”表示引用。
代码：
- 行内代码：用反引号“`”包裹代码。
- 代码块：使用三个反引号“```”包裹代码块，并可在开头指定代码语言。
链接与图片：
- 行内式链接：格式为“[链接文本](链接地址)”。
- 参考式链接：文本中使用“[链接文本][链接标记]”，在文档其他位置定义“[链接标记]: 链接地址”。
- 图片：格式为“![替代文本](图片地址)”。
表格：使用“|”分隔表格列，“-”分隔表头和内容。
水平线：使用“***”、“—”或“___”创建水平线。
任务列表：在无序列表项前添加“[ ]”（未完成）或“[x]”（已完成）。

Markdown以其简洁高效的特点，成为现代文本编辑的重要工具。通过掌握基本语法，我们能够更高效地撰写文档、分享知识。

二、Python-Markdown库的主要功能

Python-Markdown是一个用于解析和转换Markdown文档的Python库，它不仅可以将Markdown转换为HTML，还支持自定义扩展，可以根据需求添加额外的功能和样式。Python-Markdown的主要功能包括：

标准Markdown支持：支持上述Markdown基本语法。
HTML转换：将Markdown文本转换为HTML，以便在网页上显示。
自定义扩展：通过扩展来添加自定义的Markdown标记和功能。
多输出格式：除了HTML，还支持将Markdown文档转换为PDF、LaTeX等格式。

以下是一个使用Python-Markdown库将Markdown文本转换为HTML的简单示例代码：

import markdown

markdown_text = '''
# Markdown示例
这是一个**Markdown**示例文本。
- 列表项1
- 列表项2
'''
html = markdown.markdown(markdown_text)
print(html)

输出结果为：

Markdown示例
<p>这是一个<strong>Markdown</strong>示例文本。</p>
<ul>
<li>列表项1</li>
<li>列表项2</li>
</ul>

三、markdown 扩展功能

除了标准功能外，Python-Markdown库还支持多种扩展功能，以下是一些常用的扩展功能及其示例代码：

表格扩展

import markdown
from markdown.extensions.tables import TableExtension
markdown_text = """
First Header  | Second Header
------------- | -------------
Content Cell  | Content Cell
Content Cell  | Content Cell
"""

html = markdown.markdown(markdown_text, extensions=[TableExtension()])
print(html)

# <table>
# <thead>
# <tr>
# <th>First Header</th>
# <th>Second Header</th>
# </tr>
# </thead>
# <tbody>
# <tr>
# <td>Content Cell</td>
# <td>Content Cell</td>
# </tr>
# <tr>
# <td>Content Cell</td>
# <td>Content Cell</td>
# </tr>
# </tbody>
# </table>

代码高亮

python markdown代码高亮的样式是通过pygments-css来实现的，转换为html时需要将css文件引入

import markdown
from markdown.extensions.codehilite import CodeHiliteExtension
html_content = markdown.markdown(md_content, extensions=[ CodeHiliteExtension()])

自定义扩展

Python-Markdown库还支持用户创建自定义扩展，以满足特定的需求。自定义扩展通常涉及创建一个扩展类和一个预处理器类，并在扩展类中注册预处理器。示例代码如下：

from markdown.extensions import Extension
from markdown.preprocessors import Preprocessor
import re

class CustomExtension(Extension):
    def extendMarkdown(self, md):
        # 注册自定义预处理器
        md.preprocessors.register(CustomPreprocessor(md), 'custom_preprocessor', 0)

class CustomPreprocessor(Preprocessor):
    def run(self, lines):
        # 在这里处理Markdown文本的行
        # 例如，将所有出现的"FOO"替换为"Bar"
        pattern = re.compile(r'FOO')
        for i, line in enumerate(lines):
            lines[i] = pattern.sub('Bar', line)
        return lines

# 使用自定义扩展
import markdown

markdown_text = """
# Custom Extension Example
This is a FOO example.
"""
html = markdown.markdown(markdown_text, extensions=[CustomExtension()])
print(html)

在上述示例中，我们创建了一个自定义扩展CustomExtension，它包含一个预处理器CustomPreprocessor。预处理器将所有出现的"FOO"替换为"Bar"。然后，在将Markdown文本转换为HTML时，我们启用了这个自定义扩展。

四、完整示例：Markdown文件转换为HTML并设置自定义CSS

接下来，我们将通过一个完整的例子展示如何使用Python-Markdown库将一个Markdown文件转换为HTML，并设置自定义CSS进行美化。

准备Markdown文件：

创建一个名为``的Markdown文件，内容如下：

# 标题
这是一个Markdown文档的示例。

- 列表项1
- 列表项2

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

![图片](https://example.com/image.jpg)

编写Python脚本：

创建一个名为convert_md_to_html.py的Python脚本，内容如下：

import markdown
import codecs

# 读取Markdown文件
input_file = codecs.open("", mode="r", encoding="utf-8")
text = input_file.read()

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

# 添加自定义CSS
custom_style = """
<style>
body {
    font-family: Arial, sans-serif;
    background-color: #f4f4f4;
    margin: 0;
    padding: 20px;
}
h1 {
    color: #333;
}
p {
    color: #666;
}
ul {
    list-style-type: disc;
    padding-left: 20px;
}
a {
    color: #007bff;
    text-decoration: none;
}
a:hover {
    text-decoration: underline;
}
img {
    max-width: 100%;
    height: auto;
}
</style>
"""

# 将CSS和HTML内容组合
final_html = f"{custom_style}\n<body>\n{html}\n</body>"

# 保存为HTML文件
output_file = codecs.open("example.html", mode="w", encoding="utf-8")
output_file.write(final_html)

print("Markdown文件已成功转换为HTML文件！")

运行Python脚本：

在命令行中运行convert_md_to_html.py脚本：
```
python convert_md_to_html.py
```
查看结果：

打开生成的example.html文件，你将看到一个带有自定义CSS样式的HTML页面。

通过本文的介绍，我们掌握了Markdown的基本语法，了解了Python-Markdown库的主要功能，并通过一个完整的例子实现了Markdown文件到HTML文件的转换，并设置了自定义CSS进行美化。希望这些内容能够帮助你更好地使用Markdown和Python-Markdown库，提升你的文档编辑和写作效率。