技能baoyu-format-markdown
B

baoyu-format-markdown

格式化纯文本或带前置元数据的Markdown文件,包括标题、摘要、标题层级、加粗、列表和代码块。适用于用户提出“格式化Markdown”、“美化文章”、“添加格式”或优化文章排版的需求。输出文件为{文件名}-formatted.md。

baoyu-format-markdown

技能概述

自动将纯文本或 Markdown 文件转换为结构化文档,添加 frontmatter、优化标题层级、修复中英文间距,让文章排版更规范美观。

适用场景

  1. 博客文章发布前处理 自动生成博客所需的 YAML frontmatter,包括标题、摘要、slug 和封面图路径,一键输出符合 Hugo、Jekyll 等静态博客规范的 Markdown 文件。

  2. 技术文档排版优化 将散乱的纯文本笔记转换为结构化 Markdown,自动识别并列内容转为列表、提取代码块、优化标题层级,让技术文档更易读。

  3. 中文排版规范修复 自动修复中文与英文、数字之间的间距,统一全角引号使用,规范 CJK 文字的强调符号,符合中文排版规范。

核心功能

  1. 智能 Frontmatter 生成 自动检测或生成文章标题,创建包含 title、slug、summary 和 featureImage 的 YAML frontmatter。支持从文件路径推断 slug,智能生成 100-150 字的吸引人摘要,自动检测同目录下的封面图片。

  2. 内容结构化处理 自动分析文章内容,将平行内容转换为无序或有序列表,识别命令和代码并添加代码块标记,提取关键语句进行加粗强调,使用引用块标记名言或重要说明。

  3. 文本排版脚本 集成 remark-cjk-friendly 和 autocorrect 等工具,自动修复 CJK 文字的强调标点问题,添加中文与英文、数字之间的间距,可选将 ASCII 引号替换为全角引号。

常见问题

baoyu-format-markdown 会改变我的原文内容吗?

技能遵循"只添加格式,不修改内容"的原则。原文的文字和观点会被完整保留,处理仅限于添加 Markdown 格式标记(如加粗、列表、代码块)和执行排版修复(如中英文间距)。如果检测到文件已是 Markdown 格式,会询问你选择"优化格式""保持原格式仅修复排版"或"仅排版处理"。

如何自定义格式化选项?

通过 EXTEND.md 文件配置偏好设置。优先检查项目级 .baoyu-skills/baoyu-format-markdown/EXTEND.md,再检查用户级 $HOME/.baoyu-skills/baoyu-format-markdown/EXTEND.md。支持配置默认格式化选项和摘要长度偏好。脚本运行时也可通过命令行参数控制是否启用引号替换、间距调整和强调符号修复。

处理后的文件会覆盖原文件吗?

不会。处理后的内容会保存为新文件 {原文件名}-formatted.md,原文件保持不变。如果目标文件已存在,会自动备份为 {文件名}-backup-{时间戳}.md。只有在选择"仅排版处理"选项时,脚本才会直接在原文件上修改。