Skip to content

Latest commit

 

History

History
143 lines (134 loc) · 3.94 KB

cheat-sheet.md

File metadata and controls

143 lines (134 loc) · 3.94 KB
Raw
layout title description last_modified_at
default
Cheat Sheet
A quick reference to the Markdown syntax.
2018-10-18

Overview

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can't cover every edge case, so if you need more information about any of these elements, refer to our reference guides for basic syntax and extended syntax.

Basic Syntax

These are the elements outlined in John Gruber's original design document. All Markdown applications support these elements.

Element Markdown Syntax
Heading # H1
## H2
### H3
Bold **bold text**
Italic *italicized text*
Blockquote > blockquote
Ordered List 1. First item
2. Second item
3. Third item
Unordered List - First item
- Second item
- Third item
Code `code`
Horizontal Rule ---
Link [title](https://www.example.com)
Image ![alt text](image.jpg)

Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

Element Markdown Syntax
Table | Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
Fenced Code Block ```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```
Footnote Here's a sentence with a footnote. [^1]

    [^1]: This is the footnote.
  </code></td>
</tr>
<tr>
  <td><a href="/extended-syntax/#heading-ids">Heading ID</a></td>
  <td><code>### My Great Heading {#custom-id}</code></td>
</tr>
<tr>
  <td><a href="/extended-syntax/#definition-lists">Definition List</a></td>
  <td><code>
    term<br>
    : definition
  </code></td>
</tr>
<tr>
  <td><a href="/extended-syntax/#strikethrough">Strikethrough</a></td>
  <td><code>~~The world is flat.~~</code></td>
</tr>
<tr>
  <td><a href="/extended-syntax/#task-lists">Task List</a></td>
  <td><code>
    - [x] Write the press release<br>
    - [ ] Update the website<br>
    - [ ] Contact the media
  </code></td>
</tr>