GitHub Flavored Markdown (GFM): Task Lists, Footnotes, and Alert Callouts
Master advanced GitHub Flavored Markdown features. Learn the syntax for interactive task lists, footnotes, strikethrough, and GitHub alert callouts.
GitHub Flavored Markdown extends CommonMark with interactive task lists (- [ ] and - [x]), strikethrough (~~text~~), footnotes ([^1]), and standardized alert callouts using blockquote syntax (> [!NOTE], > [!TIP], > [!IMPORTANT], > [!WARNING], > [!CAUTION]).
Solve this problem now with our free Markdown Previewer & Editor
Try it instantly in your browser — zero tracking, 100% client-side privacy.
Specification & Architecture Reference
| Alert Type | Markdown Syntax | Recommended Documentation Context |
|---|---|---|
| Note | > [!NOTE] | General background information, helpful tips, or context |
| Tip | > [!TIP] | Best practices, shortcuts, or performance optimizations |
| Important | > [!IMPORTANT] | Critical requirements necessary for setup or deployment |
| Warning | > [!WARNING] | Potential breaking changes, deprecations, or subtle gotchas |
| Caution | > [!CAUTION] | High-risk actions that could cause data loss or security issues |
Beyond Standard CommonMark
GitHub Flavored Markdown (GFM) introduced several extensions that have become documentation staples across technical repositories.
1. GitHub Alert Callouts Rather than relying on ad-hoc bolding or emojis to highlight important notices, GitHub standardizes callouts using blockquote syntax:
> [!NOTE][!WARNING] Urgent info that needs immediate user attention to avoid breaking changes. ```
These render with distinctive colored borders, backgrounds, and icons (blue for Note, green for Tip, purple for Important, amber for Warning, red for Caution).
2. Interactive Task Lists Task lists render checkboxes directly in README files and issue descriptions: ```markdown - [x] Configure Tailwind CSS v4 OKLCH theme - [x] Pre-render static metadata for all 10 developer tools - [ ] Implement client-side export to ZIP ```
3. Footnotes for Technical Citations GFM supports inline numeric footnotes that link to references at the bottom of the document: ```markdown According to the Princeton GEO research study[^1], quantitative data boosts citation by 41%.
[^1]: KDD 2024 Generative Engine Optimization benchmark paper. ```
4. Strikethrough Wrap text in double tildes: `~~deprecated method~~` renders as ~~deprecated method~~.
Preview, draft, and validate GFM features with Mickytool's **Markdown Previewer & Editor**.
Solve this problem now with our free Markdown Previewer & Editor
Execute this workflow immediately without saving data on remote servers.
Frequently Asked Questions
Do GFM alerts work outside of GitHub?
Many modern static site generators and markdown processors (such as Docusaurus, Astro, and remark plugins) include plugins to render [!NOTE] style callouts identically to GitHub.
Can users toggle task list checkboxes in GitHub README files?
In README files, checkboxes are read-only. In GitHub Issues and Pull Request descriptions, users with write permissions can click checkboxes to update markdown source state directly.