markdown

Write and review lint-compliant Markdown following CommonMark, GFM, and markdownlint rules.

1|Updated Apr 8, 2026
One-click install
npx skills add https://github.com/Domush/ai-agent-web-development-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/ai-agent-web-development-skills/tree/main/skills/markdown
Command: npx skills add https://github.com/Domush/ai-agent-web-development-skills --skill markdown-domush

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Markdown files often contain subtle syntax errors, inconsistent formatting, and lint violations that break rendering or fail CI checks. This Skill provides a complete reference for authoring clean, lint-compliant Markdown so documents render correctly and pass markdownlint validation. ## Core Features & Use Cases - Lint Rule Reference: Covers the full markdownlint rule set (MD001–MD060) with aliases, tags, and inline configuration comments for surgical rule control. - Syntax Guidance: Documents CommonMark and GitHub Flavored Markdown syntax including tables, task lists, alerts, footnotes, and Mermaid diagrams. - Deprecated Pattern Detection: Lists incorrect patterns (setext headings, indented code blocks, bare URLs) alongside their correct replacements. - Use Case: When drafting a README that fails markdownlint in CI, use this Skill to identify violations like missing blank lines around lists (MD032) or code blocks without language identifiers (MD040) and fix them correctly. ## Quick Start Review my README.md file and fix all markdownlint violations while following GitHub Flavored Markdown best practices.

Frequently Asked Questions about markdown

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

FAQPage Schema
How do I fix common markdownlint errors in my README?▼

Most markdownlint errors involve missing blank lines around headings (MD022), lists (MD032), and code blocks (MD031), plus code fences without language identifiers (MD040). Add single blank lines around block elements and specify a language after the opening backticks.

How to create tables in GitHub Flavored Markdown?▼

GFM tables require a header row, a separator row with dashes like | --- | --- |, and body rows with matching column counts. Surround tables with blank lines (MD058) and use colons in the separator row for left, center, or right column alignment.

What is the difference between CommonMark and GitHub Flavored Markdown?▼

CommonMark defines core syntax like headings, lists, links, and code blocks. GitHub Flavored Markdown extends it with tables, task lists, strikethrough, autolinks, and footnotes, plus GitHub-specific features like alerts and Mermaid diagrams.

How do I disable a markdownlint rule for one line?▼

Use the inline comment <!-- markdownlint-disable-next-line MD013 --> before the target line to suppress a specific rule. Prefer this surgical approach over blanket disables, and pair markdownlint-disable with markdownlint-restore when disabling blocks.

Why is my Markdown list or table not rendering on GitHub?▼

Lists and tables fail to render when missing a preceding blank line or when tables lack the header separator row. Add a blank line before the block and ensure every table row has the same number of pipe-delimited columns.

Should I use setext or ATX headings in Markdown?▼

Use ATX headings (# Heading) consistently, as setext underline style only supports two levels and violates MD003 style consistency rules. Always include a space after the hash and never skip heading levels.