Markdown Primer

Markdown is a simple way to format text using only plaintext files. Here are some examples to get you started:

Text Styling

Italic

*Italic*

Bold

**Bold**

_subscript

~sub~script

^superscript

^super^script

Strikethrough

~~Strikethrough~~

Underline

__Underline__

Links

Visit jot.run

[Visit jot.run](https://jot.run)

Images

![Taking notes](https://media1.tenor.com/m/sjsnIFM5W14AAAAd/the-office-observing.gif)

Blockquotes

This is a quote

> This is a quote

Lists

Unordered lists

• One
• Two
• Three

 * One
 * Two
 * Three

Ordered lists

1. One
2. Two
3. Three

 1) One
 2) Two
 3) Three

Task Lists

Task lists are unordered lists with rendered checkboxes indicating completion of the task. For instance:

• Uncompleted 1
• Completed 1
• Uncompleted 2

 - [ ] Uncompleted 1
 - [x] Completed 1
 - [ ] Uncompleted 2

Code

Inline code

This shows a command in a sentence.

This shows a `command` in a sentence.

Code block

e () {
  echo "$1"
}

```bash
e () {
  echo "$1"
}
```

Note: Currently there's no default syntax highlighting but adding a language will apply the class language-[class] to the <code> tag.

Section Headings

Heading 1

# Heading 1

Heading 2

## Heading 2

These go through 5 levels (#####).

Heading Anchors

Headings also have anchor links attached to them. For instance, the Tables heading below can be linked directly with a link like this:

See tables

[See tables](#heading-tables)

Tables

Column 1	Column 2
123.45	678.9
Something	Nothing

| Column 1  | Column 2 |
| --------- | -------- |
| 123.45    | 678.9    |
| Something | Nothing  |

Alerts

You can highlight important information with alerts:

> [!NOTE]
> This is a note!

> [!TIP]
> This is a tip!

> [!IMPORTANT]
> This is important!

> [!WARNING]
> This is a warning!

> [!CAUTION]
> This is a caution!

Metadata

You can also set some useful Web metadata using Markdown front matter. Here's an example of all the currently supported keys:

---
author: Treadful
description: A rad space for cyber surfers!
exclude: false
lang: en_US
title: Treadful's Cool Web Page
---

For details on what each key means, see the HTML metadata with Markdown front matter page.

Final notes

For more details and ways to format, see the full Commonmark spec.