规范化/整理长篇 Markdown 文档(如从 PDF、网页、OCR 复制而来的技术手册、论文、白皮书),典型症状包括:标题层级被平铺在同一级(全是 ##)、带编号大纲(1. / 1.1 / 1.1.1)未分级、同一行里用分号连写的「1)2)3)」编号列表、用 ● 标记的要点未格式化、缺少可点击跳转的目录。当用户要求:(1) 修复/重建 Markdown 标题层级;(2) 把连写的编号列表拆成逐行断首;(3) 把「● 标题:内容」格式化为加粗子项并缩进;(4) 在文首生成可跳转目录(GitHub 锚点 `
Markdown 文档整理(md-doc-cleanup)是一项面向实际任务的技能,主要用于将结构混乱的长 Markdown 文档整理为层级清晰、列表规整、带可跳转目录的规范文档;文档标题被平铺在同一个级别(几乎全是 ## ),但正文带有清晰的数字编号大纲( 1. / 1.1 / 1.1.1 );
它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。
执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。该技能适合用于一次性任务,也可以接入自动化工作流,与其他技能或上层代理配合完成更完整的业务链路;在组合使用时,应明确每一步的输入输出关系,并避免不同步骤之间出现参数冲突。
将结构混乱的长 Markdown 文档整理为层级清晰、列表规整、带可跳转目录的规范文档。
##),但正文带有清晰的数字编号大纲(1. / 1.1 / 1.1.1)。; 连写多个编号项:1)…;2)…;3)…。。● 标题:内容 形式,未加粗、未断行、未缩进。脚本 scripts/cleanup_markdown.py 按固定顺序串起全部步骤,每步读入上一步的结果:
fix_headings:依据数字编号的「点」数映射层级——N.→H2(章节),N.N→H3(节),N.N.N→H4(子节);全文第一个无编号标题升为 H1(主标题);## ● 要点: 这类 ● 子标题降为 H5 并去掉 ●;带冒号的内联子标题(## 2. 检索策略:)降为 H5。fmt_list_blanks:在 ;/。 后、数字) 前插入换行,把连写编号拆成逐行;确保每个标题行与其后正文之间有一个空行(标题后已是空行或紧跟另一个标题则不插)。fmt_bullets:把 ● 标题:内容 转为 * **标题**: 并换行,内容缩进为子项 * 内容;若内容(或紧随的后续行)含 数字) 编号,则把后续编号行一并收为同级缩进子项;无冒号的纯 ● 行仅把 ● 换成 *。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。## 目录,gen_toc 会自动跳过,不重复插入。[[## 标题]] 是部分笔记/渲染器(如支持双链的工具)的语法;若目标平台是 GitHub / VS Code 预览,请用 --toc-style github。github 风格下锚点按 GitHub 规则生成(小写、去标点、空格转 -、中文保留),与渲染器默认跳转一致。git stash 或复制一份。相关专题
热门下载
相关下载
精品课程
共6课时 | 54.7万人学习
共89课时 | 134.3万人学习
共49课时 | 82.7万人学习
最新文章