GitHub Flavored Markdown

GitHub Flavored Markdown (GFM) extends basic Markdown with features developers rely on in README files and issues.

Tables

| Tool | Purpose |
| --- | --- |
| JSON Formatter | Validate API payloads |
| Markdown Preview | Draft README files |

Tables are useful for feature lists, compatibility matrices, and quick comparisons.

Fenced code blocks with language tags

```json
{
  "status": "ok"
}
```

Language tags help renderers apply syntax styling and help readers understand the snippet type immediately.

Task lists

- [x] add endpoint
- [ ] update docs
- [ ] add regression test

Task lists are common in issue templates and PR checklists.

Strikethrough

~~deprecated option~~

Useful when documenting removed config keys or deprecated API fields.

What GFM does not guarantee everywhere

Not every Markdown renderer supports every GFM feature. Before publishing:

• confirm your target platform supports tables and task lists
• avoid exotic extensions if the doc must render in multiple systems

Key takeaway

GFM is the dialect behind most GitHub README and issue content. If you write for GitHub first, tables, fenced code blocks, and task lists are usually safe choices.

Preview GFM samples in the Markdown Preview / Markdown to HTML tool before committing a README or issue template.