How do I install the Gfm skill?

Run npx skillmds@latest add tomevault-io/gfm in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the Gfm skill do?

Use when writing or reviewing GitHub-flavored Markdown (README, issues, PRs, docs) It is listed under Docs & Writing on SkillMD.

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Gfm?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Gfm by tomevault-io — Agent Skill

Name: Gfm
Author: tomevault-io

File contents

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:

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

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: gfmdescription: Use when writing or reviewing GitHub-flavored Markdown (README, issues, PRs, docs)---# GitHub-Flavored Markdown## Arguments```$ARGUMENTS```## InstructionsParse 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:**````markdown```languagecode 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):**```markdown> [!NOTE]> Useful information> [!TIP]> Helpful advice> [!IMPORTANT]> Essential info> [!WARNING]> Urgent attention> [!CAUTION]> Risk warning```**Footnotes:**```markdownText with footnote[^1].[^1]: Footnote content.```**Color swatches:** `` `#FF5733` ``, `` `rgb(255,87,51)` ``, `` `hsl(11,100%,60%)` ``### Review ChecklistWhen 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```---> Converted and distributed by [TomeVault](https://tomevault.io/claim/ivy) — claim your Tome and manage your conversions.

Frequently asked questions

Gfm