diff --git a/README.md b/README.md index ad082d8..18f1c4d 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ CraftKit 是一组面向 Codex 插件市场的中性 Skill 工具。项目从通 | 插件 | 用途 | 当前状态 | | --- | --- | --- | | `dev` | 软件设计、编码、审查与测试 | 已初始化,暂无 Skill | -| `doc` | 文档转换、整理与写作 | 已初始化,暂无 Skill | +| `doc` | 文档转换、整理与写作 | 已迁移 `format-md` | | `git` | 分支、提交、变更提取与集成 | 已初始化,暂无 Skill | | `knowledge` | 交接、复盘、经验与工作总结 | 已初始化,暂无 Skill | | `skill` | Skill 创建、迁移、检查与同步 | 已初始化,暂无 Skill | diff --git a/migration/MIGRATION_PLAN.md b/migration/MIGRATION_PLAN.md index d6ce2ed..65877a9 100644 --- a/migration/MIGRATION_PLAN.md +++ b/migration/MIGRATION_PLAN.md @@ -49,15 +49,14 @@ ### 第 1 批:低风险样板 -用于验证完整迁移闭环: +先完成唯一标准样板,再按插件推进,避免一次跨模块迁移导致集中返工: -1. `doc/format-markdown` -2. `git/summarize-commit` -3. `knowledge/prepare-handoff` -4. `doc/write-report` -5. `doc/tech-to-requirements` +1. `doc/format-md` +2. `doc/report`、`doc/requirements` +3. `git/commit-msg` +4. `knowledge/handoff` -完成门槛:固化目录模板、验证命令、行为用例和迁移记录格式。 +完成门槛:`doc/format-md` 固化目录模板、验证命令、行为用例和迁移记录格式后,才能继续本批其余 Skill。 ### 第 2 批:文档转换 @@ -211,5 +210,5 @@ plan-change - [x] 在 `AGENTS.md` 中固化分类、设计和确认流程。 - [x] 实现 Skill 与敏感内容检查脚本。 - [x] 实现迁移台账预览和更新脚本。 -- [ ] 迁移并验证首个样板 `doc/format-markdown`。 +- [x] 迁移并验证首个样板 `doc/format-md`。 - [ ] 样板通过后推进第 1 批其余 Skill。 diff --git a/migration/source-lock.json b/migration/source-lock.json index 819417d..f92ef1b 100644 --- a/migration/source-lock.json +++ b/migration/source-lock.json @@ -145,7 +145,10 @@ "source-b:023767d9c7be6295": { "sourcePathHash": "023767d9c7be62956d12fd01c94ac676b9fe6719741acd6f412c8b446efa2760", "sourceSha256": "ba579f8d6a62b4745d8d3922b33e3c20974d8081ae4d1c87727d1a9e4b609945", - "status": "pending" + "status": "migrated", + "target": "plugins/doc/skills/format-md", + "targetVersion": "0.1.0", + "reviewedAt": "2026-08-25" }, "source-b:b127c47139270a7f": { "sourcePathHash": "b127c47139270a7f9157e18ad6a0c975b99caf07b9a0874daeac86d9a99ce48c", diff --git a/plugins/doc/skills/.gitkeep b/plugins/doc/skills/.gitkeep deleted file mode 100644 index 8b13789..0000000 --- a/plugins/doc/skills/.gitkeep +++ /dev/null @@ -1 +0,0 @@ - diff --git a/plugins/doc/skills/format-md/SKILL.md b/plugins/doc/skills/format-md/SKILL.md new file mode 100644 index 0000000..764a76a --- /dev/null +++ b/plugins/doc/skills/format-md/SKILL.md @@ -0,0 +1,37 @@ +--- +name: format-md +description: 整理 Markdown 文件或指定片段的排版与语法格式,同时保持原有事实、措辞和语义不变。适用于空行、标题、列表、代码块、表格及链接格式修正;内容改写、摘要或新增图示不应触发本 Skill。 +--- + +# Markdown 排版 + +在不改变内容含义的前提下修正 Markdown 排版。优先遵循当前项目已有的 Markdown 风格;没有明确约定时采用一致、易读的常见写法。 + +## 工作范围 + +- 修正标题层级、标题前后空行和正文分段。 +- 统一有序列表、无序列表及嵌套缩进。 +- 修正围栏代码块、语言标记和代码块周围空行。 +- 对齐已有表格的分隔行、列数和必要空格。 +- 修正明显损坏的 Markdown 链接、引用及强调语法。 +- 用户指定行号或章节时,只处理该范围,并保留范围外内容。 + +## 内容边界 + +- 不改写句子,不替换术语,不增删事实、结论、数字或要求。 +- 不因追求美观改变章节顺序、列表顺序或信息层级。 +- 不默认把段落转换成表格,也不新增流程图、状态图或时序图。 +- 不修复链接指向的外部内容;只能修正可确定的 Markdown 语法。 +- 发现语义矛盾、信息缺失或需要结构性重写时,保留原文并单独说明,不擅自处理。 +- 格式调整会影响渲染语义时,先向用户确认。 + +## 执行方式 + +1. 读取目标文件及项目内适用的协作约定。 +2. 确认处理范围;未指定时处理整个目标文件。 +3. 识别纯排版问题和可能改变语义的结构问题。 +4. 只修改能够确定不会改变内容含义的格式。 +5. 检查标题、列表、代码块、表格和链接结构是否完整。 +6. 报告处理范围、主要格式调整及保留未改的问题。 + +若用户只要求查看或评估排版问题,保持只读并给出建议,不写回文件。 diff --git a/plugins/doc/skills/format-md/agents/openai.yaml b/plugins/doc/skills/format-md/agents/openai.yaml new file mode 100644 index 0000000..dfed2b1 --- /dev/null +++ b/plugins/doc/skills/format-md/agents/openai.yaml @@ -0,0 +1,4 @@ +interface: + display_name: "Format Markdown" + short_description: "整理 Markdown 排版并严格保持原文语义不变" + default_prompt: "使用 $format-md 整理这份 Markdown 文件的排版,不改写内容。"