markdown

Review Markdown files for markdownlint rule compliance and CommonMark/GFM syntax.

1|Updated Apr 8, 2026
One-click install
npx skills add https://github.com/Domush/react-skills --skill markdown-domush
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown
Source: https://github.com/Domush/react-skills/tree/main/skills/markdown
Command: npx skills add https://github.com/Domush/react-skills --skill markdown-domush

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps Markdown writing consistent, lint-compliant, and easy to read so documents never break due to malformed tables, headings, or links.

Core Features & Use Cases

  • Markdownlint-aligned guidance that calls out MD001–MD058 symptoms, explains why they matter, and shows the preferred pattern.
  • Structure and spacing playbook for headings, lists, blockquotes, tables, and fenced code that helps docs, READMEs, and knowledge bases stay uniform.
  • Reference links and common mistakes for quick fixes when reviewing documentation or onboarding new writers on GitHub-flavored Markdown.

Quick Start

Ask the markdown skill to review my README and highlight heading, table, and code block violations.

Frequently Asked Questions about markdown

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

FAQPage Schema
How do I fix markdownlint violations in GitHub-flavored Markdown files?

Fix markdownlint violations by enforcing CommonMark and GFM syntax rules for structured heading hierarchies, blank-line spacing around blocks, and fenced code with language hints. This prevents malformed tables, headings, and links in your documentation.

What is the best way to format Markdown tables and headings for README files?

The best way to format Markdown tables and headings is following a structure and spacing playbook that ensures uniform blockquotes, lists, and fenced code blocks. This maintains consistent documentation formatting across README files and knowledge bases.

Why does my Markdown formatting break when I publish change logs to GitHub?

Markdown formatting breaks when published to GitHub due to non-compliant CommonMark or GFM syntax. Missing blank-line spacing around blocks, improper heading hierarchy, or malformed tables cause rendering regressions in change logs and knowledge-base articles.

Do I need markdownlint to write consistent knowledge-base articles?

You need markdownlint rule compliance to write consistent knowledge-base articles. Adhering to MD001–MD058 rules and GFM syntax ensures structured heading hierarchies and proper table formatting, preventing documentation regressions when onboarding new writers.

Can I check my README for heading and code block violations automatically?

You can check your README for heading, table, and code block violations by applying markdownlint-aligned guidance. This reviews fenced code language hints, heading hierarchy, and spacing to highlight formatting issues and recommend preferred patterns.