Free guide · copy any example

Markdown cheat sheet

Markdown is plain text with a few marks: # for headings, ** for bold, [words](address) for links, a dash for lists and backticks for code.

Below is every mark you are likely to need, as you type it and how it looks. Each example has a copy button and opens in the free viewer.

The whole cheat sheet on one screen

You typeYou get
# Heading 1
## Heading 2
### Heading 3
Heading 1
Heading 2
Heading 3
**bold** *italic* ***both*** bold italic both
~~struck out~~ struck out (a GitHub-style extra)
[markdownwise](https://markdownwise.com) markdownwise
![A shelf of seed trays](trays.jpg) A picture, with its description shown if it can't load
- Milk
- Eggs
  - Free-range
  • Milk
  • Eggs
    • Free-range
1. Open the file
2. Read it
  1. Open the file
  2. Read it
- [x] Done
- [ ] To do
☑ Done
☐ To do (a GitHub-style extra)
`inline code` inline code
```python
print("hello")
```
A code block, with colours for the language named
> A quote
A quote
--- A line across the page
| Day | Task |
|-----|------|
| Mon | Water |
DayTask
MonWater
A note.[^1]

[^1]: The note text.
A small number that links to the note at the end
\*not italic\* *not italic* (a backslash shows a mark as itself)

Headings

Start a line with one to six hash signs and a space. One hash is the biggest heading, the title of the page; two starts a section, three a part of it. Keep one level-1 heading per file and don't skip levels, so a contents list built from them makes sense.

# Garden notes
## Watering
### Rota

Bold, italic and strikethrough

Two stars on each side make text bold, one star makes it italic, and three do both. Underscores work too, but stars also work in the middle of a word. Two tildes strike text out; that one is a GitHub-style extra.

Water the **seedlings** first, *then* the beds.
This step is ~~optional~~ required.

Links and pictures

Put the words people click in square brackets and the address straight after in round brackets, with no space between them. A picture is the same with an exclamation mark in front; the words become its description. Our Markdown viewer shows that description instead of loading pictures.

Read the [Markdown viewer guide](https://markdownwise.com/markdown-viewer).

![A shelf of seed trays](trays.jpg)

Lists and checkboxes

A dash and a space starts a list item; indent two spaces to put an item under another. For a numbered list, start each line with a number and a dot. Square brackets after the dash make a checkbox, and an x inside ticks it. Checkboxes are a GitHub-style extra that GitHub and the markdownwise viewer both show.

- Seeds
- Compost
  - Peat-free

1. Fill the trays
2. Water them

- [x] Buy seeds
- [ ] Plant them

Code

Wrap code inside a sentence in backticks. For a block, put three backticks on the line above and the line below, and name the language after the first three so viewers can colour it.

Type `python --version` to check.

```python
beds = 6
print(beds * 2)
```

Quotes, lines, tables and footnotes

A line that starts with a greater-than sign is a quote. Three dashes on their own line draw a line across the page. Tables are rows of cells between pipes with a line of dashes under the header; the Markdown table guide covers alignment and has a free generator. Footnotes are an extension that GitHub and the markdownwise viewer support.

> Water before 9 am.

---

| Day | Task  |
|-----|-------|
| Mon | Water |
| Wed | Weed  |

The library lends us its tap.[^1]

[^1]: Agreed for three years.

See your own Markdown formatted

Paste your text into the free Markdown viewer to check it: it shows the result in your browser, with nothing uploaded, and Source shows the marks again. Writing a project's front page? Start from the free README template. Need a document to print or send? The Markdown to PDF converter typesets it.

Markdown syntax questions

What is Markdown?

A way to format plain text with a few marks, such as # for a heading and ** for bold. A Markdown file ends in .md and opens in any text editor; a Markdown viewer shows it formatted.

Is Markdown the same everywhere?

The basics are, and most apps follow the CommonMark standard. Tables, checkboxes, strikethrough and footnotes are extras that GitHub and many apps add, so a plain tool may show them as text.

How do I start a new line in Markdown?

Leave a blank line to start a new paragraph. For a line break inside a paragraph, end the line with two spaces or a backslash.

How do I show a mark such as a star as itself?

Put a backslash before it: \* shows a star instead of starting italics.

How can I see my Markdown formatted?

Paste it into the free Markdown viewer. It shows the result in your browser, nothing is uploaded, and Source switches back to the marks.