How do I create a task list on GitHub?

Start list items with - [ ] for unchecked tasks and - [x] for completed tasks.

How do I add an alert box on GitHub?

Use blockquote syntax followed by an alert tag such as > [!NOTE], > [!TIP], > [!IMPORTANT], > [!WARNING], or > [!CAUTION].

Can I add footnotes in GitHub Markdown?

Yes. Use a reference like [^1] in the text and define it later with [^1]: Footnote text.

GitHub Markdown Guide – GFM, Tables, Task Lists, Alerts

Q: Does GitHub support tables in Markdown?

Yes. GitHub Flavored Markdown supports pipe tables with a header row, separator row, and aligned columns.

Basic Text Formatting

Syntax	Result	Name
`# Heading 1`	Heading 1	Heading
`bold`	bold	Bold
`italic`	italic	Italic
`~~strike~~`	~~strike~~	Strikethrough
`> quote`	quote	Blockquote
`inline code`	`inline code`	Inline code
`<sub>2</sub>`	H₂O	Subscript
`<sup>2</sup>`	x²	Superscript

GitHub Flavored Markdown is a superset of CommonMark and adds GitHub-specific extensions such as tables and task lists.

Code, Links & Media

Syntax	Use case
```js `console.log('Hi')` ```	Fenced code blocks with language hints
`[Docs](https://docs.github.com)`	Inline links
`![Alt](image.png)`	Images in README and docs
`https://github.com`	Autolinks
`[Section](#install)`	Heading anchors / section links

Example README block:

README.md main

# My Project

Install dependencies:

```bash
npm install
npm run dev
```

See the [documentation](https://docs.github.com).

Lists, Tables & Tasks

Syntax	Rendered idea
`- item`	• Bullet list item
`1. item`	1. Ordered item
`- [ ] todo`	todo
`- [x] done`	done
`\| Name \| Role \|` `\| --- \| --- \|`	Pipe table
`:--- / :---: / ---:`	Left, center, right align

Rendered issue checklist

Write docs
Add task list

Command	Status
`npm test`	passing

GitHub-Specific Features

@mentionsNotify people or teams in issues, PRs, and discussions.

Issue referencesReference issues and pull requests with #123.

AlertsUse > [!NOTE], > [!TIP], or > [!WARNING].

FootnotesAdd references with [^1] and define them later.

Emoji shortcodesInsert emoji with shortcodes like :rocket:.

Relative linksUseful for linking files inside the same repository.

NOTE GitHub alerts are ideal for callouts inside README files, documentation pages, and discussions.

Live GitHub Markdown Preview

Type GitHub Markdown on the left and see a GitHub-style rendered preview on the right. Supports headings, tables, task lists, fenced code blocks, links, and alerts.

Your GitHub Markdown

GitHub Preview

README.md preview

Frequently Asked Questions

What is GitHub Flavored Markdown?

GitHub Flavored Markdown (GFM) is GitHub's Markdown dialect based on CommonMark with extensions such as tables, task list items, strikethrough, autolinks, and restrictions on some raw HTML.

How do I make a task list on GitHub?

Use - [ ] for an empty checkbox and - [x] for a checked item. GitHub renders these as interactive task list items.

Does GitHub support tables in Markdown?

Yes. Use pipe tables with a header row and separator row, such as | Name | Value | followed by | --- | --- |. You can align columns with :---, :---:, or ---:.

How do I add an alert or callout on GitHub?

Start a blockquote with an alert keyword like > [!NOTE], > [!TIP], > [!IMPORTANT], > [!WARNING], or > [!CAUTION].

Can I use footnotes in GitHub Markdown?

Yes. Add a footnote marker such as [^1] in the text and define it later using [^1]: Footnote text. GitHub will render a numbered reference link.

Where can I use this syntax?

You can use GitHub Markdown in repository README files, issues, pull requests, discussions, and many documentation or wiki pages across GitHub.

Need a full Markdown editor?