This website's docs

Learn how to use and customise this website to your liking.

Markdown Cheatsheet

Your very own markdown reference

This cheatsheet was provided by The Markdown Guide and adapted for this site

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 the 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.

Heading

# H1

H1

## H2

H2

### H3

H3

Bold

**bold text**

bold text

Italic

*italicized text*

italicized text

Blockquote

> blockquote

blockquote

Ordered List

1. First item
2. Second item
3. Third item
  1. First item
  2. Second item
  3. Third item

Unordered List

- First item
- Second item
- Third item
  • First item
  • Second item
  • Third item

Code

`code`

code

Horizontal Rule

---

[Markdown Guide](https://www.markdownguide.org)

Markdown Guide

Image

![alt text](https://www.markdownguide.org/assets/images/tux.png)

alt text

Extended Syntax

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

Table

| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
Syntax Description
Header Title
Paragraph Text

Fenced Code Block

    ```
    {
        "firstName": "John",
        "lastName": "Smith",
        "age": 25
    }
    ```
{
    "firstName": "John",
    "lastName": "Smith",
    "age": 25
}

Footnote

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote.

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote.

Strikethrough

~~The world is flat.~~

The world is flat.

Task List

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media
  • Write the press release
  • Update the website
  • Contact the media

PREV: How to Use this Site

NEXT: Typescript Cheatsheet