2026年7月9日 周四晚上19:30,报名腾讯会议了解“如何构建自进化的动态知识库(Brain)”(限30人)
免费POC, 零成本试错
FDE知识库

FDE知识库

学习大模型的前沿技术与行业落地应用


收藏

写一个Skill: format-markdown:笔记格式美化、AI智能总结排版

发布日期:2026-04-26 10:01:25 浏览次数: 1903
作者:笑笑的笔记仓库

微信搜一搜,关注“笑笑的笔记仓库”

推荐语

分享一个自用的Claude Code小技能,帮你轻松解决Markdown格式美化与智能排版难题!

核心内容:
1. 解决mkdocs material框架下Markdown格式渲染的常见问题
2. 智能识别并修正公式、列表、表格等元素的格式错误
3. 支持Admonition等定制化语法的自动排版优化

杨芳贤
53AI创始人/腾讯云(TVP)最具价值专家

背景与起因

这是一个我自用的 Claude Code 小 Skills。阅读原文可跳转到部署🔗。

首先依然是说一下为什么要做这个。

我日常在网站发布笔记,流程如下:

写成 markdown 文件 -> mkdocs (框架) -> material (风格) -> github workflow/ pages (CICD,部署发布)。

理论上,只要做一些和 mkdocs 框架与 mkdocs materials 相适配的格式调整,即可发布到我的网站上了。但是,mkdocs material 支持一些特殊且好用的markdown语法,并且有些地方的规则与默认markdown稍有不同。试举几例:

  1. 段落公式必须与前后段之间空行,否则会渲染出错,同时段落公式内不允许在开头结尾有冗余的空行,i.e., 对于如下若干格式,只有最后一种能被正确渲染

"Case. 1(❌)"

这是我的第一行。
$$E = mc^2$$
这是我的第二行。

"Case. 2(❌)"

这是我的第三行。
\[E = mc^2\]
这是我的第四行。

"Case. 3(❌)"

这是我的第三行。

\[

E = mc^2

\]

这是我的第四行。

"Case. 4(✅)"

这是我的第五行(⬇️终于正确版)。

\[E = mc^2\]

这是我的第四行(⬆️终于正确版)。

上述代码实际渲染效果如下:

  1. 对于列表、有序列表、表格,必须与前后段落之间保持空行,否则渲染会黏连在一起。

"Case. 1(❌)"

这是列表前的第一句话。
- 这是第一点。
- 这是第二点。
- 这是第三点。
这是列表后的第一句话。

"Case. 2(❌)"

这是列表前的第一句话。
* 这是第一点。
* 这是第二点。
* 这是第三点。
这是列表后的第一句话。

"Case. 3(✅)"

这是列表前的第一句话。

- 这是第一点。
- 这是第二点。
- 这是第三点。

这是列表后的第一句话。

"Case. 4(❌)"

这是表格前的第一句话。
| Col1  | Col2  |
| :---: | :---: |
| (1,1) | (1,2) |
| (2,1) | (2,2) |
| (3,1) | (3,2) |

这是表格后的第一句话。

"Case. 5(✅)"

这是表格前的第一句话。

| Col1  | Col2  |
| :---: | :---: |
| (1,1) | (1,2) |
| (2,1) | (2,2) |
| (3,1) | (3,2) |

这是表格后的第一句话。

上述代码实际渲染效果如下:

  1. 此外,mkdocs material 有一些高度定制化的语法,比如 Admonition,header 与正文之间需要有 4-indent 的缩进。

!!! note "This is header."
This is contents.

我发现从各个地方复制过来的 markdown 文本、以前写过的笔记,往往会在很多不经意的角落里,违背这几个准则。我一开始以为可以通过 mkdocs material 的某些默认配置,实现对这几种情况的兼容,但是查阅资料并没有找到证据。同时,上述写法在官方的文档中也是首先采用的。

一方面,这种格式的修改很让我头疼。考虑到一个300~400行的精修笔记可能有几十处公式,十余处表格,手动进行调整让我觉得效率低下

另一方面,这个小问题的存在导致 markdown 的直接可交付性被极大削弱了。我不喜欢这种高度不确定性。

我希望我的Skills能自动把一些内容整理成这个格式的样子,不出格式错误。

实现

在实现过程中,深度参考了宝玉老师的 baoyu-format-markdown,基础框架只做了一些微调,保留了文章总结功能,剔除更换了 js 脚本:

  • 在我的实现中,会有一个脚本自动提取markdown文件的 AST(抽象语法树),这样我可以灵活地检索控制具体的代码块所属的类别(表格、bullet point、公式),然后对于不符合条件的格式进行前后添加空行等操作;
  • 严格保证文本一致性。除了调整格式之外,不对原文做任何操作;
  • 流程参数化,可以选择:
  • 是否进行总结
  • 是否运行脚本
  • 单独运行脚本不做其他

这是一个小 Skill,目的是对我计划发布到网站的 .md 文件进行最后一次处理,对格式进行严格的微调以适应渲染的要求,最终会返回我修改的结果。


结果

放一组输出的markdown文件及渲染结果。图中所有内容均未经过人工调整。

"Before (表格渲染错误,公式缩成行内)"

"After (理想的干净形式)"

以及:

"Before (表格渲染错误,公式缩成行内)"

"After (理想的干净形式)"

还有:

"Before (表格渲染错误,公式缩成行内)"

"After (理想的干净形式)"

运行中间会自动生成中间文件、生成分析文件和备份。目录如下:

./docs/Study/Statistics
├── AdvancedStatistics
│   └── class1.md
├── example-analysis.md. # analysis 
├── example.md   # original
├── example_formatted.md # final
└── example_formatted.md.backup-2026-03-24T07-47-38.md # backup 

最终会输出一份调整报告:


使用

可以在 ClawHub 的这个🔗 使用。


53AI,企业落地大模型首选服务商

产品:场景落地咨询+大模型应用平台+行业解决方案

承诺:免费POC验证,效果达标后再合作。零风险落地应用大模型,已交付160+中大型企业

联系我们

售前咨询
186 6662 7370
预约演示
185 8882 0121

微信扫码

添加专属顾问

回到顶部

加载中...

扫码咨询

扫码登录
登录即表示您同意《53AI网站服务协议》
服务协议

欢迎您使用【53AI 官方网站】(以下简称“本网站”或“我们”)。本《会员服务协议》(以下简称“本协议”)是您(以下简称“会员”或“用户”)与【深圳市博思协创网络科技有限公司】之间关于注册、登录及使用本网站会员服务所订立的法律协议。

在您注册或登录前,请务必审慎阅读、充分理解各条款内容,特别是免除或限制责任的条款、知识产权条款、争议解决条款等。此类条款将以加粗形式提示您注意。 当您通过微信公众号授权、手机验证码验证或其他方式成功登录本网站时,即视为您已完全理解并同意接受本协议的全部内容。

一、 定义

本网站:指由【深圳市博思协创网络科技有限公司】运营的,域名为【53ai.com】的网站及相关移动端页面。

会员服务:指本网站向注册会员提供的知识库文章查阅、内容检索及其他相关增值服务。

知识库内容:指本网站发布的包括但不限于文字、图表、数据、研究报告、行业分析等数字化内容资源。

二、 账号注册与登录

登录方式:本网站支持以下登录方式,您可根据实际情况选择:

微信公众号授权登录:您同意将您的微信OpenID信息授权给本网站,用于创建或关联会员账号。

手机验证码登录:您需提供真实有效的手机号码,并通过短信验证码完成身份验证与登录/注册。

账号安全:您的账号仅限您本人使用,禁止赠与、借用、租用、转让或售卖。因您保管不善导致的账号被盗、密码泄露等损失,由您自行承担。

实名认证:根据相关法律法规要求,我们可能要求您在特定功能下完成实名认证。如您拒绝提供,可能无法使用部分或全部服务。

未成年人保护:若您未满18周岁,请在法定监护人的陪同下阅读本协议,并在征得监护人同意后使用本服务。

三、 服务内容与规范

知识库查阅权限:会员登录后,有权按照其会员等级对应的权限范围,在线浏览、检索本网站知识库中的相关文章及内容。

服务变更:我们有权根据业务发展需要,调整、变更或终止部分服务内容,并将以网站公告、公众号消息等方式提前通知。

禁止行为:您在使用服务时不得实施以下行为:

利用技术手段批量爬取、下载、转存知识库内容;

将知识库内容用于商业目的或未经授权地向第三方传播;

干扰本网站正常运行或侵犯其他用户合法权益;

发布违法违规信息或从事违反公序良俗的活动。

四、 知识产权声明

权利归属:本网站知识库中的排版设计、软件代码等内容的知识产权均归【公司全称】或原权利人所有,受《中华人民共和国著作权法》等法律保护。

有限许可:本网站授予会员一项非独占、不可转让、不可转授权的普通许可,仅限于个人学习、研究之目的在线查阅知识库内容。

侵权追责:未经书面许可,任何单位或个人不得以任何形式复制、转载、摘编、镜像、汇编或以其他方式使用上述内容。一经发现,我们保留追究其法律责任的权利。

五、 个人信息保护

我们重视对您个人信息的保护。关于我们如何收集、使用、存储和保护您的个人信息,请单独阅读 《隐私政策》。

您通过微信公众号授权或手机号验证所提供的信息,我们将严格按照《个人信息保护法》的规定处理,仅用于身份识别、服务提供及安全验证等必要用途。

您可以随时通过网站设置或联系客服行使查阅、更正、删除个人信息及撤回授权同意的权利。

六、 免责声明

内容准确性:知识库内容仅供参考,不构成专业建议。我们不对其完整性、准确性、时效性作任何明示或暗示的保证,您应自行判断并承担使用风险。

不可抗力:因自然灾害、政策法规变化、网络故障、第三方平台接口异常(如微信接口维护、运营商短信通道故障)等不可抗力导致的服务中断或延迟,我们不承担违约责任。

第三方链接:本网站可能包含指向第三方网站的链接,该等网站的内容和服务不受我们控制,请您自行甄别风险。

七、 违约责任

如您违反本协议约定,我们有权视情节采取警告、限制功能、暂停服务、注销账号等措施,并保留要求赔偿损失的权利。

如因您的违约行为导致我们遭受行政处罚、第三方索赔或商誉损失,您应承担全部赔偿责任(包括但不限于罚款、赔偿金、律师费、公证费等)。

八、 法律适用与争议解决

本协议的订立、执行和解释均适用中华人民共和国大陆地区法律。

因本协议产生的或与本协议有关的任何争议,双方应友好协商解决;协商不成的,任何一方均可向【公司所在地】有管辖权的人民法院提起诉讼。

九、 其他

本协议构成双方就本服务达成的完整协议,取代此前任何口头或书面约定。

本协议任一条款被认定为无效或不可执行的,不影响其他条款的效力。

我们对本协议享有最终解释权,并在法律允许的范围内保留随时修改的权利。修改后的协议一经公布即生效,继续使用服务即视为同意修订内容。


已查阅