四时宝库

程序员的知识宝库

使用Python实现Markdown文件与HTML文件互相转换,超简单!!!

一、Markdown基础知识回顾

Markdown由约翰格鲁伯(John Gruber)在2004年创造,是一种轻量级标记语言,其设计理念旨在实现 “易读易写”,让人们能使用简单的纯文本格式编写文档,这种设计极大地降低了写作和排版的门槛,让创作者无需深入学习复杂的排版语法,就能快速生成结构清晰、格式规范的内容,文档以md为后缀,比如python编程.md。

Markdown的语法基础入门

1. 标题

使用#到######表示不同级别的标题,#为一级标题,######为六级标题。

# Python函数式编程入门
## 什么是函数式编程
## Python中的函数式编程特性
### 高阶函数
### 匿名函数lambda

2. 列表

  • 无序列表:使用-、*或+开头。
- 支持多平台同步
- 提供在线协作编辑
- 具备数据自动备份功能
  • 有序列表:使用数字加点。
1. 打开应用程序
2. 点击“新建项目”按钮
3. 输入项目名称和描述
4. 点击“创建”完成
  • 列表嵌套:在列表项内再次使用列表标记,即可实现列表嵌套
1. 一级列表项1
   - 二级列表项1.1
   - 二级列表项1.2
2. 一级列表项2
   - 二级列表项2.1

3. 强调

  • 加粗:用两个*或**包裹文本。
  • 斜体:用一个*或_包裹文本。
  • 斜体加粗:使用三个 *** 或 ___ 来表示斜体加粗。

4. 链接与图片

  • 链接:格式为[链接文字](链接地址)。
  • 图片:格式为![图片描述](图片地址)。

5. 代码

  • 行内代码:用反引号`包裹。
`print(“Hello, World!”)`
  • 代码块:用三个反引号```包裹,并可指定语言。
```python
def add(a, b):
    return a + b
```

6.换行

在Markdown中,若需要在段落中插入换行符,则需在行尾添加两个或多个空格并回车。

7.表格

Markdown 支持基本的表格语法。使用 | 分隔列,- 用于分隔表头和表格内容。

| 姓名 | 年龄 | 性别 |
| ---- | ---- | ---- |
| 小明 | 25 | 男 |
| 小红 | 22 | 女 |

8.引用

使用 > 来创建引用块,后面要有空格,通常用于引用他人或书籍中的文字。

> 这是引用的文字。

9. 脚注

使用 [^脚注标记] 表示脚注引用

[^1]: 这是脚注的具体内容。

10. 任务列表

使用 - [ ] 表示未完成的任务,- [x] 表示已完成的任务

- [ ] 任务1
- [x] 任务2

11. 特殊符号转义

当需要显示Markdown语法中的特殊符号(如 #、*、_、{}、[]、()、>、+、-、.、! 等)时,可在符号前添加反斜杠 \ 进行转义。例如:

\# 这不会被识别为标题,而是显示#

二、markdown库将md文件转为html文件

1. 安装markdown库

markdown库是Python处理Markdown文本的基础库,使用前通过pip命令安装:pip install markdown

2. markdown.markdown():核心转换函数

  • 功能:将输入的Markdown格式文本精准转换为对应的HTML格式文本。
  • 参数

text(必填):传入待转换的Markdown格式字符串。

extensions(可选):启用额外扩展功能,如表格支持、数学公式渲染等。

  • 案例:创建一个md文档并转为html文件
创建一个Markdown文本文件test.md 内容如下
# 标题1 这是一段**加粗**的文字。
 - 支持多平台同步
 - 提供在线协作编辑
 - 具备数据自动备份功能

## 标题1.1 这是一段*斜体*的文字。
1. 打开应用程序
2. 点击“新建项目”按钮
3. 输入项目名称和描述
4. 点击“创建”完成
         
### 标题1.1.1 这是一段**加粗**的文字。
 [头条号地址](https://mp.toutiao.com)

 ![科雷软件测试头像](https://sf3-cdn-tos.toutiaostatic.com/img/user-avatar/074a8ce9c7ae00701f93078d684b08be~300x300.image)

#### 标题1.1.1.1 这是一段测试代码。
```print(‘hello python’)```
             

打开test.md文件获取内容并转为html,并保存为html文件。

import markdown

def save_html(htmlfile,content):
    with open(htmlfile,'w',encoding='utf8') as f:
        f.write(content)

# Markdown文本
md_text = open('test.md','r',encoding='utf8').read()
print(md_text)
# 转换为HTML
html_text = markdown.markdown(md_text)
print(html_text)
save_html('test1.html',html_text)

输出结果

<h1>标题1 这是一段<strong>加粗</strong>的文字。</h1>
<ul>
<li>支持多平台同步</li>
<li>提供在线协作编辑</li>
<li>具备数据自动备份功能</li>
</ul>
<h2>标题1.1 这是一段<em>斜体</em>的文字。</h2>
<ol>
<li>打开应用程序</li>
<li>点击“新建项目”按钮</li>
<li>输入项目名称和描述</li>
<li>点击“创建”完成</li>
</ol>
<h3>标题1.1.1 这是一段<strong>加粗</strong>的文字。</h3>
<p><a href="https://mp.toutiao.com">头条号地址</a></p>
<p><img alt="科雷软件测试头像" src="https://sf3-cdn-tos.toutiaostatic.com/img/user-avatar/074a8ce9c7ae00701f93078d684b08be~300x300.image" /></p>
<h4>标题1.1.1.1 这是一段测试代码。</h4>
<p><code>print(‘hello python’)</code></p>

用浏览器打开html文件,展示如下:

启用扩展功能案例

import markdown
# 含表格的Markdown文本
md_text = """
| 水果 | 价格 |
|------|------|
| 苹果 | 5元 |
| 香蕉 | 3元 |
"""
# 启用表格扩展
html_text = markdown.markdown(md_text, extensions=["tables"])
print(html_text)

输出结果

<table>
<thead>
<tr>
<th>水果</th>
<th>价格</th>
</tr>
</thead>
<tbody>
<tr>
<td>苹果</td>
<td>5元</td>
</tr>
<tr>
<td>香蕉</td>
<td>3元</td>
</tr>
</tbody>
</table>

三. mistune库将md文件转为html文件

mistune是一款快速、轻量的Markdown解析器,安装命令:pip install mistune

mistune.create_markdown():灵活的解析器创建函数

  • 功能:创建 Markdown 解析器对象,支持自定义渲染规则,灵活度更高
  • 参数:可传入渲染器、插件等,定制解析行为。
  • 案例:将上面的md文件通过mistune转换为html文件
import mistune

def save_html(htmlfile,content):
    with open(htmlfile,'w',encoding='utf8') as f:
        f.write(content)

# Markdown文本
md_text = open('test.txt','r',encoding='utf8').read()
print(md_text)
# 转换为HTML
md = mistune.create_markdown()
html_text = md(md_text)
print(html_text)
#保存为html文件
save_html('test1.html',html_text)

自定义渲染器案例

import mistune
#自定义一个渲染器 继承mistune的HTMLRenderer类 重写父类的方法
class CustomRenderer(mistune.HTMLRenderer):
    def heading(self, text, level):
        if level == 1:
            return f'<h1 class="custom-h1">{text}</h1>\n'
        return super().heading(text, level)

重新输出结果

def save_html(htmlfile,content):
    with open(htmlfile,'w',encoding='utf8') as f:
        f.write(content)

# Markdown文本
md_text = open('test.txt','r',encoding='utf8').read()
print(md_text)
#使用自定义渲染器创建解析器
md = mistune.create_markdown(renderer=CustomRenderer())
html_text = md(md_text)
print(html_text)
save_html('test1.html',html_text)

四 html2text库将html文件转为markdown文件

初始化HTML2Text类,使用handle函数将html内容转为markdown内容。

  • ignore_links/ignore_images:是否忽略链接和图片
  • body_width:设置行宽(0=禁用自动换行)
  • single_line_break:是否将单换行符转换为空格
  • bypass_tables:是否跳过表格转换
  • protect_links:保护特殊链接格式(如 mailto:)
# 安装:pip install html2text
import html2text

def html_to_markdown(html_file, md_file):
    # 创建转换器并配置选项
    h = html2text.HTML2Text()
    h.ignore_links = False      # 保留链接
    h.ignore_images = False     # 保留图片
    h.body_width = 0            # 禁用自动换行
    h.mark_code = True          # 保留代码块
    
    with open(html_file, "r", encoding="utf-8") as f:
        html_content = f.read()
    
    markdown_content = h.handle(html_content)
    
    with open(md_file, "w", encoding="utf-8") as f:
        f.write(markdown_content)

# 使用示例
html_to_markdown("test.html", "output.md")

将上面转换好的html文件再次转为markdown文件,转换后如下:

# 标题1 这是一段**加粗** 的文字。

  * 支持多平台同步
  * 提供在线协作编辑
  * 具备数据自动备份功能

## 标题1.1 这是一段 _斜体_ 的文字。

  1. 打开应用程序
  2. 点击“新建项目”按钮
  3. 输入项目名称和描述
  4. 点击“创建”完成

### 标题1.1.1 这是一段**加粗** 的文字。

[头条号地址](https://mp.toutiao.com)

![科雷软件测试头像](https://sf3-cdn-tos.toutiaostatic.com/img/user-avatar/074a8ce9c7ae00701f93078d684b08be~300x300.image)

#### 标题1.1.1.1 这是一段测试代码。

`print(‘hello python’)`

发表评论:

控制面板
您好,欢迎到访网站!
  查看权限
网站分类
最新留言
    友情链接