Python 中 Markdown 庫的使用：從入門到實踐

編程獅（w3cschool.cn） 2025-04-28 17:45:55 瀏覽數(shù) (713)

反饋

文檔編寫是開發(fā)過程中不可或缺的一部分。Python 的 Markdown 庫為我們提供了一個高效、簡潔的方式來編寫和展示文檔。本文將深入淺出地介紹如何在 Python 中使用 Markdown 庫。

一、Markdown 簡介

Markdown 是一種輕量級標記語言，它允許人們使用易讀易寫的純文本格式編寫文檔，然后轉(zhuǎn)換成結(jié)構(gòu)化的 HTML（或者其他格式）。Markdown 的語法簡潔明了，易于學習，因此在編程社區(qū)中廣泛使用。

訪問Markdown編輯器教程學習Markdown語法。

二、Python 中的 Markdown 庫

Python 中有多個 Markdown 庫可供選擇，其中最流行的包括 markdown 和 mistune。本文將重點介紹 markdown 庫的使用。

1. 安裝 Markdown 庫

在開始之前，確保你已經(jīng)安裝了 markdown 庫?？梢酝ㄟ^ pip 安裝：

pip install markdown

2. 基本用法

導入庫并轉(zhuǎn)換 Markdown 文本

以下是一個簡單的示例，展示如何將 Markdown 文本轉(zhuǎn)換為 HTML：

import markdown


# Markdown 文本
md_text = """
# 標題
## 子標題
- 列表項 1
- 列表項 2
- 列表項 3


**加粗文本** 和 *斜體文本*


`代碼塊`


[鏈接](http://www.15014759268.cn)
"""


# 轉(zhuǎn)換為 HTML
html = markdown.markdown(md_text)


print(html)

使用文件

你還可以從文件讀取 Markdown 內(nèi)容并轉(zhuǎn)換為 HTML：

import markdown


# 讀取 Markdown 文件
with open('example.md', 'r', encoding='utf-8') as f:
    md_text = f.read()


# 轉(zhuǎn)換為 HTML
html = markdown.markdown(md_text)


# 保存為 HTML 文件
with open('output.html', 'w', encoding='utf-8') as f:
    f.write(html)

3. 擴展與自定義

Markdown 庫支持擴展，允許你自定義解析規(guī)則和輸出。例如，可以添加目錄生成、腳注等功能。

添加目錄

import markdown
from markdown.extensions.toc import TocExtension


# Markdown 文本
md_text = """
# 標題
## 子標題 1
## 子標題 2
## 子標題 3
"""


# 轉(zhuǎn)換為 HTML 并添加目錄
html = markdown.markdown(md_text, extensions=[TocExtension(permalink=True)])


print(html)

添加腳注

import markdown
from markdown.extensions.footnotes import FootnoteExtension


# Markdown 文本
md_text = """
# 標題


這是一個帶有腳注的文本[^1]。


[^1]: 這是腳注內(nèi)容。
"""


# 轉(zhuǎn)換為 HTML 并添加腳注
html = markdown.markdown(md_text, extensions=[FootnoteExtension()])


print(html)