markdown

Format and validate Markdown files using CommonMark, GFM, and markdownlint rules.

2|1|Updated Jun 30, 2019

Search Tags:#documentation #markdown #formatting #lint #markdownlint #gfm #commonmark

Ready to run

npx skills add https://github.com/tgautier/dotfiles --skill markdown-tgautier

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown
Source: https://github.com/tgautier/dotfiles/tree/main/claude/skills/markdown
Command: npx skills add https://github.com/tgautier/dotfiles --skill markdown-tgautier

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Markdown formatting and structure conventions to make Markdown content consistent, readable, and maintainable across projects.

Core Features & Use Cases

Enforces headings, lists, tables, code blocks, links, and whitespace rules.
Provides guidance for consistent style across READMEs, CLAUDE.md, notes, and documentation.
Use Case: standardize new docs and review existing files for style drift.

Quick Start

Apply this skill to format and review Markdown documents following CommonMark, GFM, and markdownlint conventions.

Frequently Asked Questions about markdown

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

FAQPage Schema

How do I enforce consistent Markdown formatting across documentation?▼

To enforce consistent Markdown formatting, apply structural rules for headings, lists, tables, and code blocks using CommonMark and GFM conventions. This standardizes documentation style and prevents drift across project files like READMEs and guides.

What is the best way to lint Markdown files for style drift?▼

The best way to lint Markdown files for style drift is to run markdownlint checks that validate links, whitespace, and structural rules. This identifies formatting inconsistencies and provides actionable corrections for existing documentation.

Does this Markdown validation work with both CommonMark and GFM?▼

Yes, this Markdown validation works with both CommonMark and GFM. It applies structural rules and lint-like checks according to these specifications while accommodating project-specific styles for documentation formatting.

How do I standardize Markdown headings, tables, and code blocks?▼

To standardize Markdown headings, tables, and code blocks, apply automated formatting rules that enforce structural consistency. This validates elements against CommonMark and GFM specifications to ensure documentation remains readable and maintainable.

Can I customize Markdown lint rules for project-specific documentation styles?▼

Yes, you can customize Markdown lint rules for project-specific documentation styles. While enforcing standard structural rules, the formatting accommodates project-specific styles and provides actionable corrections tailored to your conventions.

Why does my Markdown formatting break in READMEs and notes?▼

Markdown formatting breaks in READMEs and notes due to style drift and inconsistent structure. Applying markdownlint checks for headings, lists, and whitespace enforces consistent conventions and provides actionable corrections to fix the issues.