Skills
.Work. You
Rest

check-markdown

Community

Automatically normalize and fix Markdown files

Content & Communication#documentation#markdown#formatting#docusaurus#mkdocs#vitepress#admonitions
AuthorCloudyWing
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Detects common Markdown formatting and platform-specific syntax issues and provides a guided workflow to list, confirm, and batch-fix them so documentation remains consistent and render-safe across sites.

Core Features & Use Cases

  • Platform detection for VitePress, Docusaurus, MkDocs (Material), and fallback to GitHub Flavored Markdown.
  • Admonition/callout mapping per platform and preservation of platform-specific syntax such as MDX, Vue components, and frontmatter.
  • General linting rules: single H1 enforcement, heading spacing, list marker normalization, consistent nested list indentation, code fence language tags, image alt text requirements, table separator spacing, and link validation.
  • Workflow that enumerates issues, asks for user confirmation, and then applies non-destructive, semantics-preserving batch fixes.

Quick Start

Ask the skill to check and fix the Markdown file README.md for formatting, list, and platform-specific admonition issues.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: check-markdown
Download link: https://github.com/CloudyWing/ai-dotfiles/archive/main.zip#check-markdown

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.