Back to Projects
SuperMD

SuperMD

SuperMD is a comprehensive Markdown assistant built specifically for AI, supporting generation, conversion, review, optimization, and style switching with a single command, with a focus on Chinese typography and standardized structure.

Project Overview

⚑ SparkCore Studio

πŸ“ SuperMD

All-in-One Markdown Assistant β€” Generate, Convert, Audit, Improve, and Switch Formats for Claude Code

πŸ“– Introduction

SuperMD is a Claude Code Skill that unifies Markdown workflows into five modes, covering the entire lifecycle from generation to review and polish. Whether you need to write a README, tidy up pasted notes, check formatting compliance, optimize layout, or convert between GFM / Obsidian / MDX, a single natural-language command triggers the right mode.

Key highlights:

  • One skill for the complete Markdown workflow β€” no switching between multiple tools
  • Built-in document templates (README, API docs, tutorials, study notes, meeting minutes, etc.)
  • Chinese typography friendly: auto-inserts spaces between Chinese & English, normalizes punctuation
  • Strict document structure rules: no skipped heading levels, every code block has a language label, no bare URLs in links

⬇️ Installation

git clone https://github.com/Ruyi0623/SuperMD.git ~/.claude/skills/supermd

No extra configuration needed. Claude Code loads it automatically. Use /supermd to invoke.

βš™οΈ Five Modes

πŸš€ Generate β€” Create from scratch

Generate a structured Markdown document from a plain description. Recognizes document type and target audience, matches the best template, and outputs a ready-to-use file. For large documents (>500 words) it first presents a structure outline.

πŸ”„ Convert β€” Raw content to Markdown

Turn unstructured text into clean, well-formatted Markdown. Automatically infers structure, preserves all original information, and removes formatting noise.

πŸ” Audit β€” Diagnostic review

Inspect .md files item by item and produce a three-level diagnostic report: Critical, Suggestions, and Strengths. Audits only β€” no modifications.

✨ Improve β€” Polish and fix

Fix skipped heading levels, bare URLs, unlabeled code blocks, inconsistent list markers, Chinese typography issues β€” without altering the meaning of the content.

πŸ”€ Switch β€” Format conversion

Convert between GFM ↔ Obsidian ↔ MDX ↔ Standard, automatically handling wikilinks, callout syntax, and other differences.

πŸ“ Document Structure Principles

  • Each document has exactly one # H1 heading
  • Heading levels are contiguous β€” no skipping (e.g., H1 directly to H3)
  • Code blocks always carry a language identifier; use a specific language name, never code
  • Links use descriptive text; avoid bare URLs
  • Images must include alt text: ![descriptive text](url)
  • Auto-insert spaces between Chinese and Western characters; use Chinese punctuation in Chinese contexts

πŸ”€ Format Conversion at a Glance

Source Target Key Changes
GFM Obsidian [text](url) β†’ [[url|text]], lowercase callouts
Obsidian GFM [[wikilinks]] β†’ [text](url), keep #tags
GFM MDX Add live attribute to code blocks, add import statements
Standard GFM Enable autolinks, task lists, tables, strikethrough

πŸ’‘ Usage Examples

# Generate
/supermd write a product documentation for a VitePress project

# Convert
/supermd convert this HTML to Markdown

# Audit
/supermd check docs/api.md for issues

# Improve
/supermd optimize the layout of this document

# Format switch
/supermd convert this file from Obsidian to GFM

Tech Stack

Markdown