当前位置：首页 > news >正文

Python 第三方库：Markdown（将文本渲染为 HTML）

news 2025/11/16 5:28:39

markdown 是一个流行的第三方 Python 库，用于将 Markdown 标记语言转换为 HTML。它是众多文档系统、博客平台（如 MkDocs、Pelican、Jupyter Notebook）底层的核心渲染引擎之一。

通过 markdown 库，你可以轻松地将 Markdown 文件或字符串内容转换为标准 HTML 网页，也可通过插件系统自定义语法、样式与输出结构。

安装：

pip install markdown

常见应用场景：

（1）Markdown → HTML 渲染

将 Markdown 格式的文档、博客内容、安全文本等转换为 HTML。

（2）自定义扩展支持

支持多种内置或第三方扩展，如表格、目录（TOC）、代码高亮、脚注等。

（3）文档系统构建

用于构建静态网站、帮助文档、WYSIWYG 编辑器后端等。

（4）与 Web 框架集成

可在 Flask、Django、FastAPI 等中集成，实现 Markdown 文章即时渲染。

◆ ◆ ◆

核心概念

1、Markdown 文本

一种轻量级标记语言，用于快速书写格式化文档（标题、列表、链接、代码等）。

2、HTML 渲染

markdown.markdown() 是核心函数，将 Markdown 文本转换为 HTML 字符串。

3、扩展机制（Extensions）

提供强大的插件系统，可启用额外语法，如表格、目录、数学公式等。

4、安全性控制

输出 HTML 可选择安全模式或自行过滤，以防止 XSS 攻击。

5、Markdown 实例（Markdown class）

除简单转换外，也可以通过 Markdown() 对象进行多次渲染、状态管理与配置扩展。

◆ ◆ ◆

应用举例

例 1：基本 Markdown 转换为 HTML

import markdown
text = """# 欢迎使用 Markdown
这是一个 **加粗** 的文本示例。"""
html = markdown.markdown(text)print(html)

输出：

<h1>欢迎使用 Markdown</h1><p>这是一个 <strong>加粗</strong> 的文本示例。</p>

例 2：启用扩展（如表格与代码高亮）

import markdown
text = """| 姓名 | 分数 || ---- | ---- || 张三 | 90   || 李四 | 85   |
```pythonprint("Hello Markdown!")

例 3：生成带目录（TOC）的 HTML 文档

import markdown
text = """# 第一章内容一
## 小节 1.1内容二
## 小节 1.2内容三"""
html = markdown.markdown(text, extensions=["toc"])print(html)

toc 扩展会自动生成锚点目录，可配合网页模板实现自动导航。

例 4：在 Flask 中渲染 Markdown 网页

from flask import Flask, render_template_stringimport markdown
app = Flask(__name__)
@app.route("/")def index():    text = "# Hello Flask + Markdown\n这是 **动态渲染** 的内容。"    html = markdown.markdown(text)    return render_template_string("<html><body>{{ html|safe }}</body></html>", html=html)
if __name__ == "__main__":    app.run(debug=True)

运行后访问 http://localhost:5000/，即可看到 Markdown 渲染结果。

例 5：使用自定义扩展类

from markdown.extensions import Extensionfrom markdown.preprocessors import Preprocessorimport re, markdown
class UppercaseExtension(Extension):    def extendMarkdown(self, md):        md.preprocessors.register(UppercasePreprocessor(md), 'uppercase', 175)
class UppercasePreprocessor(Preprocessor):    def run(self, lines):        return [line.upper() for line in lines]
text = "hello markdown"html = markdown.markdown(text, extensions=[UppercaseExtension()])print(html)

输出：