讲师中心 微信公众号

工具推荐

视频效率加速
Seko
Seko

AI短剧一键生成成片

updream

一键生成高质量推广成片

Laper
Laper

剧本策划到成片协作

剧云
剧云

中文短剧剧本制作平台

格式化md文档

Polar Sponsor
爱发电 赞助
.NET 9.0

规范化/整理长篇 Markdown 文档(如从 PDF、网页、OCR 复制而来的技术手册、论文、白皮书),典型症状包括:标题层级被平铺在同一级(全是 ##)、带编号大纲(1. / 1.1 / 1.1.1)未分级、同一行里用分号连写的「1)2)3)」编号列表、用 ● 标记的要点未格式化、缺少可点击跳转的目录。当用户要求:(1) 修复/重建 Markdown 标题层级;(2) 把连写的编号列表拆成逐行断首;(3) 把「● 标题:内容」格式化为加粗子项并缩进;(4) 在文首生成可跳转目录(GitHub 锚点 `

Markdown 文档整理(md-doc-cleanup)

功能概述

Markdown 文档整理(md-doc-cleanup)是一项面向实际任务的技能,主要用于将结构混乱的长 Markdown 文档整理为层级清晰、列表规整、带可跳转目录的规范文档;文档标题被平铺在同一个级别(几乎全是 ## ),但正文带有清晰的数字编号大纲( 1. / 1.1 / 1.1.1 );

核心要点

  • 同一行内用;
  • 连写多个编号项: 1)…;
  • 要点用 ● 标题:内容 形式,未加粗、未断行、未缩进。

使用与执行

它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。

结果检查与注意事项

执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。该技能适合用于一次性任务,也可以接入自动化工作流,与其他技能或上层代理配合完成更完整的业务链路;在组合使用时,应明确每一步的输入输出关系,并避免不同步骤之间出现参数冲突。

Markdown 文档整理(md-doc-cleanup)

将结构混乱的长 Markdown 文档整理为层级清晰、列表规整、带可跳转目录的规范文档。

适用场景

  • 文档标题被平铺在同一个级别(几乎全是 ##),但正文带有清晰的数字编号大纲(1. / 1.1 / 1.1.1)。
  • 同一行内用 ; 连写多个编号项:1)…;2)…;3)…。。
  • 要点用 ● 标题:内容 形式,未加粗、未断行、未缩进。
  • 没有目录,或目录链接在目标渲染器里无法点击跳转。

处理流程(4 步,按顺序执行)

脚本 scripts/cleanup_markdown.py 按固定顺序串起全部步骤,每步读入上一步的结果:

  1. 重建标题层级 fix_headings:依据数字编号的「点」数映射层级——N.→H2(章节),N.N→H3(节),N.N.N→H4(子节);全文第一个无编号标题升为 H1(主标题);## ● 要点: 这类 ● 子标题降为 H5 并去掉 ●;带冒号的内联子标题(## 2. 检索策略:)降为 H5。
  2. 拆分列表 + 标题空行 fmt_list_blanks:在 ;/。 后、数字) 前插入换行,把连写编号拆成逐行;确保每个标题行与其后正文之间有一个空行(标题后已是空行或紧跟另一个标题则不插)。
  3. 格式化要点 fmt_bullets:把 ● 标题:内容 转为 * **标题**: 并换行,内容缩进为子项 * 内容;若内容(或紧随的后续行)含 数字) 编号,则把后续编号行一并收为同级缩进子项;无冒号的纯 ● 行仅把 ● 换成 *。
  4. 生成目录 gen_toc:在 H1 标题之后插入 ## 目录 + 说明 + TOC 列表 + --- 分隔线。TOC 默认提取到 H3(章节+节),H4/H5 不进目录。链接风格由 --toc-style 决定。

脚本用法

# 默认:重建层级 + 拆分列表 + 格式化要点 + 生成 wiki-link 风格目录(到 H3)
python scripts/cleanup_markdown.py article.md

# 生成 GitHub 标准锚点链接的目录
python scripts/cleanup_markdown.py article.md --toc-style github

# 目录细化到子节(H4)
python scripts/cleanup_markdown.py article.md --toc-depth 4

# 只做其中某几步(用 --skip-* 关闭其余步骤)
python scripts/cleanup_markdown.py article.md --skip-toc          # 不生成目录
python scripts/cleanup_markdown.py article.md --skip-headings     # 标题已正确时跳过层级重建

参数

参数 默认 说明
path 必填 目标 .md 文件路径(脚本就地修改该文件)
--toc-depth 3 目录包含的层级深度:2=仅章节,3=章节+节,4=含子节
--toc-style wikilink wikilink 生成 [[## 标题]];github 生成 [标题](#锚点)
--skip-headings off 跳过标题层级重建
--skip-list off 跳过列表拆分与标题空行
--skip-bullets off 跳过要点格式化
--skip-toc off 跳过目录生成

注意事项 / 边界情况

  • 幂等与适用范围:本流程针对「标题平铺 + 编号大纲」这类混乱文档设计。对层级已经正确的文档重复运行 fix_headings 可能破坏结构,此时用 --skip-headings。
  • 目录防重复:若文档前 50 行已存在 ## 目录,gen_toc 会自动跳过,不重复插入。
  • wiki-link 兼容性:[[## 标题]] 是部分笔记/渲染器(如支持双链的工具)的语法;若目标平台是 GitHub / VS Code 预览,请用 --toc-style github。
  • 中文锚点:github 风格下锚点按 GitHub 规则生成(小写、去标点、空格转 -、中文保留),与渲染器默认跳转一致。
  • 执行前建议备份:脚本就地修改原文件,处理重要文档前先 git stash 或复制一份。
目录

热门AI工具

更多
UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

相关专题

更多
Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

0

2026.11.12

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

0

2026.11.12

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

0

2026.11.12

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

0

2026.11.06

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

0

2026.11.06

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

0

2026.11.05

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

0

2026.11.05

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

0

2026.11.04

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn