如何规范化 Markdown 列表的缩进结构

梦宇大大_7291

梦宇大大_7291

2026-11-02

484人浏览

原创

如何规范化 Markdown 列表的缩进结构

本文介绍一种基于正则表达式与状态跟踪的 python 方法,用于自动修复第三方生成的 markdown 文档中混乱的列表缩进(如不一致空格、多余换行、嵌套层级错位),使其符合 commonmark 标准并兼容主流解析器(如 python-markdown、mistune)。

本文介绍一种基于正则表达式与状态跟踪的 python 方法,用于自动修复第三方生成的 markdown 文档中混乱的列表缩进(如不一致空格、多余换行、嵌套层级错位),使其符合 commonmark 标准并兼容主流解析器(如 python-markdown、mistune)。

在自动化文档生成流程中,常需处理由非标准工具输出的 Markdown 原文——这类内容虽语义正确,但缩进不统一、空行冗余、嵌套层级错乱,极易导致 HTML 渲染异常(例如子项脱离父列表、格式塌陷或解析失败)。核心挑战在于:Markdown 列表的嵌套层级并非由绝对缩进值决定,而是依赖于同一列表内首个缩进项所确立的“缩进单位”(如 2 空格或 4 空格),后续项需按该单位的整数倍对齐;而混用无序(*, -, +)与有序(1., 2.)列表时,还需独立维护类型状态。

以下方案采用单次正则遍历 + 全局状态跟踪,高效完成三重净化:

  1. 压缩冗余空行:将 ≥3 个连续换行符统一替换为两个(保留段落分隔,消除列表中断);
  2. 标准化列表符号:统一使用 - 表示无序项(兼容性最佳),保留原始数字序号;
  3. 动态重算嵌套层级:以列表中首个缩进项的空格数为基准单位,后续项缩进按 floor(实际空格数 / 单位) + 修正 计算,并强制使用 4 空格/级的标准缩进。
import re

def sanitize_markdown_lists(md_text: str) -> str:
    # 步骤1:压缩多余空行(≥3 → 2)
    md_text = re.sub(r'\n{3,}', '\n\n', md_text.strip())

    # 步骤2:匹配所有列表项(支持无序/有序,捕获缩进、标记、内容)
    list_pattern = re.compile(
        r'(^|\n+)(\s*)(([-*+])|(\d+\.\s*))(\s+)(.*)$', 
        re.MULTILINE
    )

    # 状态变量(闭包模拟,避免全局污染)
    state = {
        'prev_level': 0,      # 上一项的嵌套层级(0=顶层)
        'multiplicity': 0,    # 当前列表的缩进单位(如4空格/级)
        'prev_state': 0       # 0=未开始, 1=无序列表, 2=有序列表
    }

    def fix_item(match):
        nonlocal state
        prefix = match.group(1) or '\n'  # 行首或换行符
        indent_ws = match.group(2) or ''
        bullet = match.group(4)
        enum_num = match.group(5)
        spacer = match.group(6) or ''
        content = match.group(7) or ''

        # 判定当前列表类型
        current_state = 1 if bullet else 2

        # 计算当前层级:仅当有缩进时才计算
        current_level = 0
        if indent_ws:
            if state['prev_level'] == 0:
                # 首个缩进项:确立缩进单位
                state['multiplicity'] = len(indent_ws)
                current_level = 1
            else:
                # 按单位换算层级(向上取整处理错位)
                unit = state['multiplicity']
                current_level = (len(indent_ws) + unit - 1) // unit

        # 构建标准化输出
        result = prefix if state['prev_state'] == current_state else '\n'
        result += ' ' * (current_level * 4)  # 强制4空格/级
        result += '-' if bullet else (enum_num or '')
        result += spacer
        result += content

        # 更新状态
        state['prev_level'] = current_level
        state['prev_state'] = current_state
        return result

    # 执行替换
    return list_pattern.sub(fix_item, md_text)

# 使用示例
raw_md = """## Enumeration
1. Element 1
2. Element 2

## List (all elements rely on the same topic)

* Element 1 level 1
    * **Element 2** Level 2
* Element 3 level 1
  * Element 4 level 2
    * Element 5 level 3

- Element 6 level 1
  - Element 7 level 2
    - Element 8 level 3"""

clean_md = sanitize_markdown_lists(raw_md)
print(clean_md)

✅ 关键优势:

Markdown Toolkit
Markdown Toolkit

Markdown瑞士军刀——目录生成、格式转换(MD↔HTML)、损坏格式修复、HTML剥离、文件合并、YAML frontmatter验证器、...

下载
  • 无需外部依赖:纯 Python re 模块实现,轻量可靠;
  • 状态感知:准确区分不同列表上下文,避免跨列表层级污染;
  • 容错修正:对 2 或 6 空格等非整除缩进自动向上取整,防止子项“消失”;
  • 渲染友好:输出严格遵循 CommonMark 规范,可无缝接入 markdown-it-py、mistune 或 Python-Markdown。

⚠️ 注意事项:

  • 本方案假设列表项间无复杂内联结构干扰(如代码块、HTML 标签)。若存在,建议先用 markdown-it-py 的 parse() 获取 AST 进行结构化清洗;
  • 对含 > 引用块或 ::: 脚注的混合文档,需前置剥离再处理;
  • 生产环境建议添加单元测试,覆盖边界用例(如单行列表、空内容、超深嵌套)。

经此处理,原始混乱列表将转化为语义清晰、缩进统一、渲染稳定的 Markdown,显著提升自动化文档管线的鲁棒性与可维护性。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

markdown

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Uvicorn 报错与问题解决教程
Uvicorn 报错与问题解决教程

本专题汇总了Uvicorn服务器常见问题与报错解决的教程合集,涵盖启动失败、端口占用、模块导入错误、事件循环冲突及热重载失效等典型故障的排查思路。同时整理了多进程与Worker配置、SSL/HTTPS证书报错、跨域与代理配置等实战解决方案,助你快速定位并解决Uvicorn运行中的各类问题。

2026.11.02

0

14

Uvicorn使用教程
Uvicorn使用教程

本专题汇总了Uvicorn使用教程与启动运行指南,涵盖其作为Python ASGI服务器的定位与特点,以及命令行启动(uvicorn main:app --reload)、参数配置(host/port/workers)、程序内嵌运行与Gunicorn结合部署等核心用法。同时整理了热重载调试、日志配置与生产环境部署优化等技巧,助你快速掌握Uvicorn的运行与配置。

2026.11.02

0

17

Uvicorn安装配置教程
Uvicorn安装配置教程

本专题汇总了Uvicorn的安装配置教程与部署指南,涵盖通过pip安装Uvicorn、启动FastAPI/Starlette应用、开发模式热重载(--reload)及多进程工作模式配置等核心操作。同时整理了结合Gunicorn的生产部署方案、HTTPS与反向代理配置及性能调优技巧,助你快速完成Uvicorn服务的安装与上线部署。

2026.11.02

0

17

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

2026.10.28

100

16

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

2026.10.28

80

15

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

2026.10.28

240

10

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

140

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

140

10

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

2026.10.22

100

15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Markdown标记语言快速入门
Markdown标记语言快速入门

共30课时 | 4.4万人学习

vscode常用插件与markdown语法介绍
vscode常用插件与markdown语法介绍

共10课时 | 1.5万人学习