Skip to content
gfm logo

GitHub-Flavored Markdown

gfm

Use when writing or reviewing GitHub-flavored Markdown (README, issues, PRs, docs)

SKILL.md

Full skill instructions

GitHub-Flavored Markdown

Arguments

$ARGUMENTS

Instructions

Parse arguments to determine task:

  • File path → Write/​edit markdown file
  • "review" → Audit existing markdown for GFM best practices
  • Topic/​description → Draft markdown content

Writing Guidelines

Structure:

  • Use heading hierarchy (# through ######)—GitHub auto-generates TOC for 2+ headings
  • Prefer ATX headings (#) over Setext (===)
  • One blank line before headings

Text styling:

StyleSyntax
Bold**text**
Italic_text_
Bold+italic***text***
Strikethrough~~text~~
Code`code`
Subscript<sub>x</​sub>
Superscript<sup>2</​sup>

Code blocks:

```language
code here
```

Lists:

  • Unordered: use - consistently
  • Ordered: 1., 2., etc.
  • Task lists: - [ ] incomplete, - [x] complete
  • Nest by aligning under parent text

Links:

  • Inline: [text](url)
  • Section anchors: [text](#heading-name) (lowercase, hyphens, no punctuation)
  • Relative paths for repo files: docs/​CONTRIBUTING.md

Images: ![alt text](url) — always include alt text

Alerts (callouts):

> [!NOTE]
> Useful information

> [!TIP]
> Helpful advice

> [!IMPORTANT]
> Essential info

> [!WARNING]
> Urgent attention

> [!CAUTION]
> Risk warning

Footnotes:

Text with footnote[^1].

[^1]: Footnote content.

Color swatches: `#FF5733`, `rgb(255,87,51)`, `hsl(11,100%,60%)`

Review Checklist

When reviewing markdown:

  • Heading hierarchy is logical (no skipped levels)
  • Code blocks specify language for syntax highlighting
  • Links use relative paths for repo files
  • Images have meaningful alt text
  • Task lists use proper syntax
  • Alerts use correct > [!TYPE] format
  • No trailing whitespace except intentional line breaks
  • Tables are properly aligned

Examples

/​gfm README.md                → Edit/​create README
/​gfm review docs/             → Audit markdown files in docs/
/​gfm API documentation        → Draft API docs content
/​gfm changelog entry          → Write changelog in GFM style

More Other skills

Delegate independent tasks to specialized agents working concurrently with isolated context.

295.4K 206.3K
View

Applies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.

179.7K 100.1K
View

Toolkit for styling artifacts with a theme. These artifacts can be slides, docs, reportings, HTML landing pages, etc. There are 10 pre-set themes with colors/fonts that you can apply to any artifact that has been creating, or can generate a new theme on-the-fly.

179.7K 89.5K
View

A set of resources to help me write all kinds of internal communications, using the formats that my company likes to use. Claude should use this skill whenever asked to write some sort of internal communications (status reports, leadership updates, 3P updates, company newsletters, FAQs, incident reports, project updates, etc.).

179.7K 76.1K
View

Fundamental design principles for writing maintainable, testable Python code.

40.2K 21.9K
View

Modern responsive layouts using container queries, fluid typography, CSS Grid, and mobile-first strategies.

40.2K 20K
View

Generate Playwright tests from scenarios using interactive browser exploration and validation.

39.7K 18.2K
View

Modern React state management with Redux Toolkit, Zustand, Jotai, and React Query for every state category.

40.2K 14.7K
View

GDPR-compliant data handling with consent management, data subject rights, and privacy controls.

40.2K 14.3K
View

Python error handling patterns including input validation, exception hierarchies, and partial failure handling. Use when implementing validation logic, designing exception strategies, handling batch processing failures, or building robust APIs.

40.2K 13.5K
View

Detailed multi-file refactor planning with safety checks and rollback guidance.

39.7K 13K
View