gfm

Format GitHub-flavored Markdown with correct headings, code blocks, links, and callouts.

9|Updated Jul 15, 2025
One-click install
npx skills add https://github.com/ivy/dotfiles --skill gfm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gfm
Source: https://github.com/ivy/dotfiles/tree/main/home/dot_claude/skills/gfm
Command: npx skills add https://github.com/ivy/dotfiles --skill gfm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

GitHub-flavored Markdown is the de facto standard for READMEs, issues, PRs, and docs, but inconsistency in formatting can slow collaboration and reduce readability.

Core Features & Use Cases

  • Enforces and guides proper GFM syntax including headings, code blocks, links, images, and callouts.
  • Ensures consistent heading hierarchy and readable formatting across Markdown documents.
  • Supports auditing and improving existing Markdown for readability and accessibility in real-world repos.

Quick Start

Draft or review a Markdown document following GFM best practices to ensure clean, consistent, and accessible output.

Frequently Asked Questions about gfm

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

FAQPage Schema
How do I enforce consistent heading hierarchy in GitHub-flavored Markdown?

Standardize GitHub-flavored Markdown by validating heading levels, ensuring readable formatting, and checking content against common GFM conventions for READMEs, issues, and PRs.

What is the best way to review README files for GitHub Markdown conventions?

Review README files by auditing documents for proper GFM syntax, accessible formatting, correct code block highlighting, and valid relative links to ensure clean and consistent collaboration.

How do I format code blocks and syntax highlighting in GitHub issues and PRs?

Format code blocks in GitHub issues and PRs by applying GitHub-flavored Markdown syntax rules that enforce correct language tags for syntax highlighting to ensure readable and consistent documentation.

Does standard Markdown formatting work for GitHub project documentation?

While standard Markdown works for GitHub project documentation, using GitHub-flavored Markdown adds specific callouts, relative links, and syntax highlighting conventions that ensure better readability and accessibility.

Why does my GitHub Markdown formatting look inconsistent across repositories?

GitHub Markdown formatting looks inconsistent across repositories when documents lack enforced heading hierarchy, standardized code blocks, and accessible formatting guidelines applied during the drafting and reviewing process.