返回项目列表
项目介绍
星核网络工作室 · SparkCore
📝 SuperMD
Markdown 全能助手 —— 为 Claude Code 打造的生成、转换、审查、优化与格式切换技能
📖 简介
SuperMD 是一个 Claude Code Skill,将 Markdown 文档工作流整合为五种模式,覆盖从零生成到审查优化的完整生命周期。无论是写 README、整理粘贴的笔记、检查文档格式规范、优化排版,还是在 GFM / Obsidian / MDX 之间转换,一句自然语言即可触发对应模式。
核心特色:
- 一技能覆盖 Markdown 全流程,无需在多个工具间切换
- 内置文档模板(README、API 文档、技术教程、学习笔记、会议记录等)
- 中文排版友好:自动处理中英文空格、标点规范
- 严格遵循文档结构原则:层级不跳跃、代码块必有语言标识、链接禁用裸 URL
⬇️ 安装
git clone https://github.com/Ruyi0623/SuperMD.git ~/.claude/skills/supermd
克隆后无需额外配置,Claude Code 自动加载。输入 /supermd 即可调用。
⚙️ 五种模式
🚀 Generate — 从零生成
根据需求描述自动创建结构化 Markdown 文档。识别文档类型与目标受众,匹配最佳模板,输出可直接使用。大型文档(>500 词)会先展示结构大纲。
🔄 Convert — 原始内容转 Markdown
将非结构化文本整理为规范 Markdown,自动推断结构,保留全部原始信息,去除格式噪音。
🔍 Audit — 审查诊断
逐项检查 .md 文件,输出三级诊断报告:严重、建议、优点。只诊断不修改。
✨ Improve — 优化改进
修复层级跳跃、裸 URL、无语言标签的代码块,统一列表符号,修正中文排版,不改变内容含义。
🔀 Switch — 格式转换
GFM ↔ Obsidian ↔ MDX ↔ Standard 之间互转,自动处理 wikilink、callout 等语法差异。
📐 文档结构原则
- 每个文档有且仅有一个
# H1标题 - 标题层级连续,不跳跃(禁止 H1 → H3)
- 代码块始终标注语言标识,用具体语言名而非
code - 链接使用描述性文字,避免裸 URL
- 图片必须有 alt 文字:
 - 中文与英文/数字之间自动加空格,中文语境使用中文标点
🔀 格式转换一览
| 源格式 | 目标格式 | 关键变更 |
|---|---|---|
| GFM | Obsidian | [text](url) → [[url|text]],callout 转小写 |
| Obsidian | GFM | [[wikilinks]] → [text](url),#tags 保留 |
| GFM | MDX | 代码块加 live 属性,补充 import 语句 |
| Standard | GFM | 启用自动链接、任务列表、表格、删除线 |
💡 使用示例
# 生成 /supermd 帮我写一个 VitePress 项目的产品文档 # 转换 /supermd 把这段 HTML 转成 Markdown # 审查 /supermd 检查 docs/api.md 有什么问题 # 优化 /supermd 优化这份文档的排版 # 格式切换 /supermd 把这个文件从 Obsidian 转成 GFM