OpenParable
Skip to content
← Back to skills

Gfm

Documents
gfm

Gfm is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/data/gfm/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/gfm, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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