Markdown & GFM Syntax Reference

Markdown Cheat Sheet & GFM Guide

Searchable quick reference for standard Markdown and GitHub Flavored Markdown (GFM). Copy formatted tables, code fences, interactive task lists, and GitHub callout alerts with one click.

GitHub Note Alert
alerts

Official GitHub Flavored Markdown callout alert rendered with blue outline in GitHub issues & READMEs.

Markdown Syntax
> [!NOTE]
> Highlights useful information that users should know.
GitHub Warning Alert
alerts

Amber-styled alert block used to warn against breaking changes and deprecations.

Markdown Syntax
> [!WARNING]
> Critical content demanding immediate user attention.
GitHub Tip Alert
alerts

Green-styled callout block for best practices and optimization tips.

Markdown Syntax
> [!TIP]
> Helpful advice for doing things better or more easily.
GitHub Important Alert
alerts

Purple-styled callout emphasizing requirements and prerequisites.

Markdown Syntax
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
GitHub Caution Alert
alerts

Red alert for high-risk operations (e.g. data loss or security issues).

Markdown Syntax
> [!CAUTION]
> Negative potential consequences of an action.
Aligned Table (Left, Center, Right)
tables

Colons in the header separator row define text alignment (:--- left, :---: center, ---: right).

Markdown Syntax
| Feature | Status | Notes |
| :--- | :---: | ---: |
| Zero-Server | Active | 100% On-Device |
| Offline PWA | Ready | Installable |
Fenced Code Block with Language Syntax Highlighting
code

Specify the language identifier directly after the first three backticks.

Markdown Syntax
```typescript
interface User {
  id: string;
  email: string;
  active: boolean;
}
```
Inline Code
code

Wrap code tokens in single backticks for monospace inline rendering.

Markdown Syntax
Run `npm run build` to verify production assets.
Interactive Task Lists (Checkboxes)
lists

Rendered as clickable checkboxes on GitHub and modern markdown viewers.

Markdown Syntax
- [x] Complete security review
- [ ] Deploy to production
- [ ] Send release notes
Nested Ordered & Unordered Lists
lists

Indent sub-items with exactly 3 or 4 spaces.

Markdown Syntax
1. Phase 1: Planning
   - Architecture review
   - Schema modeling
2. Phase 2: Execution
Headings (H1 through H4)
headings

Always add a space between the '#' characters and the heading title.

Markdown Syntax
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
Bold, Italic, Strikethrough
formatting

Standard markdown formatting supported across all markdown engines.

Markdown Syntax
**Bold text**, *italic text*, and ~~strikethrough text~~.
Collapsible Details / Accordion Block
formatting

Leave a blank line after <summary> so markdown inside details parses properly.

Markdown Syntax
<details>
<summary>Click to view debug logs</summary>

```json
{"status": 200, "ok": true}
```
</details>
Hyperlink with Title Tooltip
links

Optional quotation string after URL provides accessible tooltip text.

Markdown Syntax
[DevToolkit Hub](https://devtoolkit-hub.vercel.app/ "Visit DevToolkit Hub")
Shields.io Badge with Link
links

Standard syntax for GitHub project README headers.

Markdown Syntax
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
Footnote Reference and Definition
links

GFM footnote spec. Clickable anchor links between citation and reference.

Markdown Syntax
Zero-server tools process data on-device[^1].

[^1]: Verified via browser DevTools network tab.

Markdown Previewer

Live client-side GitHub Flavored Markdown editor with real-time HTML compiler.

Open Markdown Editor

GitHub README Generator

Generate production-ready README.md files with badges, tech stack, and structure.

Open README Generator

Code & Text Diff Checker

Compare markdown files, documents, and code line-by-line with unified patch export.

Open Diff Checker

Frequently Asked Questions

How do I create callout alerts in GitHub Markdown?

GitHub uses blockquote syntax prefixed with an alert tag: '> [!NOTE]', '> [!TIP]', '> [!IMPORTANT]', '> [!WARNING]', or '> [!CAUTION]'. They render with distinctive icons and colors on GitHub repositories, issues, and discussions.

How do I align table columns to the left, center, or right in Markdown?

Use colons in the header divider row: ':---' for left alignment, ':---:' for center alignment, and '---:' for right alignment.

How do I render interactive checkboxes and task lists in Markdown?

Prefix list items with '- [ ] ' for an unchecked task or '- [x] ' for a completed task. GitHub and modern editors render these as interactive checkboxes.

How do I add syntax highlighting to a fenced code block?

Specify the language identifier immediately after the opening triple backticks, such as ```typescript, ```python, ```json, or ```bash.