宝玉格式

文档 社区 v1.57.0

技能解读

baoyu-format-markdown 不是「跑一遍 Prettier」这么浅——它是把粗稿自动整形成「读者友好」版本的 Markdown:补 frontmatter、统一标题阶梯、识别并加粗关键句、整理列表、规范代码块。

核心约定

作者强调:不改变任何原始内容。它只调结构和呈现,不替你改字。所以可以放心给作者交付的文章用。

工作流

按 Workflow 章节:① 读输入文件,识别它是纯文本还是已带部分 Markdown;② Highlights & Key Insights:找出文章核心句,用粗体或引用标记;③ Structure Assessment:检查标题阶梯是否合理(不要 H1→H3 跳级),列表层级是否正确;④ Reader-Important Information:识别「读者最该看到的信息」并前置;⑤ Formatting Issues:修空行、错位的代码 fence、混乱的列表;⑥ Typos Found:列出疑似错别字(不替你改,列给你看)。

输入输出

输入支持纯 txt / 半结构化 Markdown / 老式 HTML 转 MD 的脏稿。输出始终是干净的 Markdown,顶部带 frontmatter(标题、摘要、tags)。

适合的场景

  • 把语音转写、AI 草稿、剪贴板素材整理成博客
  • 把多人协作的 Markdown 草稿统一成一致风格
  • 发文前最后一道质检
  • 整理读书笔记 / 会议纪要

与 baoyu-markdown-to-html 的关系

这个负责打磨结构(让 Markdown 自身更好读),baoyu-markdown-to-html 负责输出排版(适配公众号 / 博客的 HTML)。两个技能配合就是「先把内容理顺,再让样式上线」。

不适合

风格化散文、小说——它的「加粗关键句」逻辑会让文学味打折;正式法律 / 学术论文——格式应严格按目标期刊模板,让它自动加粗反而麻烦。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
92 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@JimLiu · v1.57.0 · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
需手动接入
是否需要外部接口密钥
不需要
兼容的系统
macOS · Linux · Windows
运行环境要求
Bun · Python
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 命令执行
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 1 步:读取并检测内容类型

读取用户指定的文件,然后检测内容类型: 指示符 · 分类有 `---` YAML frontmatter · Markdown 有 `#`、`##`、`###` 标题 · Markdown 有 `bold`、`*italic*`、列表、代码块、块引用 · Markdown

02
步骤 2:分析内容(读者的角度)

仔细阅读全部内容。站在读者的角度思考:什么可以帮助他们快速理解和记住关键信息?进行涵盖以下维度的分析: 2.1 要点和关键见解 作者提出的核心论点或结论 令人惊讶的事实、数据点或反直觉的主张

03
第 3 步:检查/创建 Frontmatter、标题和摘要

检查 YAML frontmatter(`---` 块)。如果丢失则创建。字段·处理`title`·参见下面的标题生成`slug`·从文件路径推断或从标题生成`summary`·一句话简明摘要(参见下面的摘要生成)

04
第四步:格式化内容

应用第 2 步分析指导的格式。目标是使内容易于浏览并且关键点不会被错过。格式化工具包:元素·何时使用·格式标题·自然主题边界、分节符·`##`、`###`层次结构粗体·关键结论、重要术语、核心要点·`bold`

05
第5步:保存格式化文件

另存为`{original-filename}-formatted.md` 备份现有文件:

06
第 6 步:执行排版脚本

在输出文件上运行格式化脚本: 脚本选项:选项 · 简短 · 描述 · 默认 `--quotes` · `-q` · 将 ASCII 引号替换为全角引号 `"..."` · false `--no-quotes` · 不替换引号

07
第7步:完成报告

显示总结所有所做更改的报告:调整报告以反映实际更改 - 忽略未进行更改的类别。

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。