check-markdown

Detects and corrects Markdown formatting and platform-specific admonitions in documentation files.

Updated Mar 1, 2026
One-click install
npx skills add https://github.com/CloudyWing/ai-dotfiles --skill check-markdown
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-markdown
Source: https://github.com/CloudyWing/ai-dotfiles/tree/main/skills/check-markdown
Command: npx skills add https://github.com/CloudyWing/ai-dotfiles --skill check-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about check-markdown

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix markdown formatting issues in Docusaurus or VitePress?

Fix markdown formatting by detecting and correcting list normalization, heading validation, and platform-specific admonitions for Docusaurus or VitePress. The workflow enumerates issues and prompts for confirmation before applying batch fixes.

What is the best way to normalize markdown admonitions across different documentation sites?

Normalizing markdown admonitions involves platform detection and mapping callout syntax for VitePress, Docusaurus, and MkDocs. This ensures documentation remains render-safe and preserves platform-specific syntax like MDX and Vue components.

Does this markdown linter support GitHub Flavored Markdown and MDX files?

Yes, this markdown linter supports GitHub Flavored Markdown as a fallback and explicitly processes both .md and .mdx files. It validates heading rules, code fence language tags, and image alt text while preserving frontmatter and platform-specific components.

How do I enforce single H1 headings and consistent list markers in markdown files?

Enforce single H1 headings and consistent list markers by applying markdown linting rules to your documentation files. The workflow checks heading spacing, normalizes list markers, and corrects nested list indentation before applying non-destructive batch fixes.

Can I review markdown formatting issues before they are automatically fixed?

Yes, you can review markdown formatting issues before they are fixed because the workflow enumerates all detected problems and asks for user confirmation. It then applies non-destructive, semantics-preserving batch fixes only after you approve.

Why do my markdown tables and code fences render incorrectly in MkDocs?

Markdown tables and code fences render incorrectly in MkDocs when table separator spacing is inconsistent or code fence language tags are missing. Detecting these formatting issues and applying guided corrections ensures your documentation renders safely.