Automated summary

This skill guides writing and reviewing GitHub-flavored Markdown (READMEs, issues, pull requests, docs) using GitHub's conventions for structure, links, alerts, and code blocks.

Strengths

Covers GitHub-specific GFM features: `> [!NOTE]` alerts, task lists, footnotes, and color swatches
Ships a concrete review checklist (heading hierarchy, code-block languages, relative paths, alt text)
Separates three explicit modes: a file path, a "review" audit, and drafting from a topic
Catches easily missed details such as section anchors and trailing whitespace

Limitations

Does not validate or render the Markdown — no automated check of output or links
Rules are style conventions only; no linter config or CI integration is provided
Assumes a GitHub context and ignores quirks of other Markdown engines

When to use it

Use it when drafting or reviewing a README, docs page, or PR description that will live on GitHub and should follow GFM conventions.

When not to use it

Skip it for Markdown targeting another renderer (MDX, AsciiDoc, static-site docs with custom extensions) where GitHub's rules don't apply.

Security analysis

Safe

Quality score88/100

The skill only provides guidance for writing and reviewing GitHub-flavored Markdown. It declares no tools and contains no instructions to execute commands, access networks, or handle sensitive data.

No concerns found

How this analysis is made

Examples

Audit a docs folder

/gfm review docs/

Write a README

/gfm README.md — write a README for this repo with install steps, usage examples, and a task list of known limitations

Draft API docs

/gfm API documentation — draft GFM docs for our REST endpoints with code blocks and a WARNING alert about rate limits

name: gfm description: Use when writing or reviewing GitHub-flavored Markdown (README, issues, PRs, docs) argument-hint: "[file | topic | review]"

GitHub-Flavored Markdown

Name: GitHub-Flavored Markdown Guide
Author: Skills Guide Bot

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: | Style | Syntax | |-------|--------| | 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

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/github-flavored-markdown-guide-muar2zfa' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/github-flavored-markdown-guide-muar2zfa/download' --output '.skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md.part' && mv '.skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md.part' '.skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code

test -f '.skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md' && test -s '.skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/gfm' && cp -R '.skill-downloads/github-flavored-markdown-guide-muar2zfa' '.claude/skills/gfm'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation

openskills install './.skill-downloads/github-flavored-markdown-guide-muar2zfa'

openskills read 'github-flavored-markdown-guide-muar2zfa'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544

Skills Guide Bot