Markdown Syntax Guide

A Markdown syntax reference, headings and text styles, lists and task lists, links and images, fenced code blocks, tables, and other formatting, including GitHub-flavored extras.

Markdown is a plain-text formatting syntax that converts to HTML. It powers READMEs, GitHub comments, and countless note apps. Below is the common syntax; most renderers also support the GitHub Flavored Markdown (GFM) extras noted at the end.

Headings & text

MarkdownResult
# Heading 1Top-level heading (use ##–###### for smaller)
**bold**bold
*italic*italic
~~strike~~strikethrough
`code`inline code
> quoteBlock quote

Lists

MarkdownResult
- item or * itemBulleted list
1. itemNumbered list
  - nestedIndent two spaces to nest
- [ ] todoUnchecked task (GFM)
- [x] doneChecked task (GFM)

Links & images

MarkdownResult
[text](https://url.com)A hyperlink
[text](url "title")Link with hover title
![alt](image.png)An image (note the leading !)
<https://url.com>Auto-linked bare URL

Code blocks

Wrap multiple lines in triple backticks, optionally naming the language for highlighting:

```js
function hi() {
  return "hello";
}
```

Tables (GFM)

Separate cells with pipes; the second row sets alignment with colons:

| Name  | Score |
| :---- | ----: |
| Alice |    90 |
| Bob   |    72 |

Other

MarkdownResult
---Horizontal rule (on its own line)
Two spaces at line endForces a line break
\*literal\*Backslash escapes a special character
Blank lineSeparates paragraphs

Markdown flavors differ: tables, task lists, and strikethrough are GFM extensions, not part of the original spec. When in doubt, leave a blank line between block elements, it resolves most rendering surprises.

What this does

A Markdown syntax guide covers headings and text styles, lists and task lists, links and images, code blocks, tables, and GitHub-flavored extras.

How to use it

  1. Browse by element.
  2. Find the syntax you need.
  3. Copy it with one tap.
  4. Paste it into your document.

Example

# Title makes a top-level heading; **bold** makes bold text.

Sources & methodology

Last updated .

Frequently asked questions

What is Markdown?

Markdown is a lightweight plain-text formatting syntax that converts to HTML. It powers READMEs, GitHub comments, and many note-taking apps.

Why do tables or task lists not work?

Tables, task lists, and strikethrough are GitHub Flavored Markdown (GFM) extensions, not part of the original spec. Your renderer must support GFM.

How do I show a literal asterisk or backtick?

Escape it with a backslash, e.g. \* renders a literal asterisk. For literal backticks inline, wrap the text in more backticks than it contains.