Reference

Markdown cheatsheet

Every core Markdown construct, the HTML it produces, and how it renders. Examples are converted live at build time with the same engine as the converter.

Headings

One to six # characters.

Markdown

# Heading 1
## Heading 2
### Heading 3

HTML

<h1>Heading 1</h1>
<h2>Heading 2</h2>
<h3>Heading 3</h3>

Rendered

Heading 1

Heading 2

Heading 3

Bold, italic and strikethrough

Strikethrough needs GFM.

Markdown

**bold**, *italic*, ***both***, ~~strikethrough~~

HTML

<p><strong>bold</strong>, <em>italic</em>, <em><strong>both</strong></em>, <del>strikethrough</del></p>

Rendered

bold, italic, both, ~~strikethrough~~

Links

Inline, titled, and autolinks.

Markdown

[Inline link](https://example.com)

[With a title](https://example.com "Example")

https://example.com

HTML

<p><a href="https://example.com">Inline link</a></p>
<p><a href="https://example.com" title="Example">With a title</a></p>
<p><a href="https://example.com">https://example.com</a></p>

Rendered

Inline link

With a title

https://example.com

Images

Same as a link, with a leading !.

Markdown

![Site logo](/favicon.svg)

HTML

<p><img src="/favicon.svg" alt="Site logo"></p>

Rendered

Unordered lists

Use -, * or +. Indent two spaces to nest.

Markdown

- Apples
- Oranges
  - Blood orange
- Pears

HTML

<ul>
  <li>Apples</li>
  <li>Oranges
    <ul>
      <li>Blood orange</li>
    </ul>
  </li>
  <li>Pears</li>
</ul>

Rendered

Apples
Oranges
- Blood orange
Pears

Ordered lists

Numbers do not have to be sequential.

Markdown

1. First
2. Second
3. Third

HTML

<ol>
  <li>First</li>
  <li>Second</li>
  <li>Third</li>
</ol>

Rendered

First
Second
Third

Task lists

GFM checkboxes.

Markdown

- [x] Write the draft
- [ ] Publish it

HTML

<ul>
  <li><input checked="" disabled="" type="checkbox"> Write the draft</li>
  <li><input disabled="" type="checkbox"> Publish it</li>
</ul>

Rendered

Write the draft
Publish it

Blockquotes

Prefix lines with >.

Markdown

> Simple is better
> than complex.

HTML

<blockquote>
  <p>Simple is better
  than complex.</p>
</blockquote>

Rendered

Simple is better than complex.

Inline code

Wrap in backticks.

Markdown

Run `npm install` first.

HTML

<p>Run <code>npm install</code> first.</p>

Rendered

Run npm install first.

Fenced code blocks

Add a language after the opening fence for highlighting.

Markdown

```js
const answer = 42;
```

HTML

<pre><code class="hljs language-js"><span class="hljs-keyword">const</span> answer = <span class="hljs-number">42</span>;
</code></pre>

Rendered

const answer = 42;

Tables

GFM. Colons in the divider row set alignment.

Markdown

| Name | Qty |
| ---- | --: |
| Tea  |   2 |
| Milk |  10 |

HTML

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th align="right">Qty</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Tea</td>
      <td align="right">2</td>
    </tr>
    <tr>
      <td>Milk</td>
      <td align="right">10</td>
    </tr>
  </tbody>
</table>

Rendered

Name	Qty
Tea	2
Milk	10

Horizontal rule

Three or more -, * or _.

Markdown

Above

---

Below

HTML

<p>Above</p>
<hr>
<p>Below</p>

Rendered

Above

Below

Line breaks

End a line with two spaces or a backslash, or enable “Line breaks as <br>”.

Markdown

First line\
Second line

HTML

<p>First line<br>Second line</p>

Rendered

First line
Second line

Escaping

Backslash-escape special characters.

Markdown

\*not italic\*

HTML

<p>*not italic*</p>

Rendered

*not italic*

Not in core Markdown

Footnotes, definition lists, math, and emoji shortcodes are extensions that this converter does not process. Raw HTML inside your Markdown is passed through when Sanitize HTML is off, and cleaned when it is on.

Try it in the converter Markdown to HTML for email