Markdown Guide

In this document we will present an example followed by a code block showing the markdown syntax used to create the example.

Standard Markdown

Emphasis

bold
italics
strikethrough

**bold**
*italics*
~~strikethrough~~

Headers

Big header

Medium header

Small header

Tiny header

# Big header
## Medium header
### Small header
#### Tiny header

Lists

• Generic list item
• Generic list item
• Generic list item

- Generic list item
- Generic list item
- Generic list item

1. Numbered list item
2. Numbered list item
3. Numbered list item

1. Numbered list item
2. Numbered list item
3. Numbered list item

Links

Text to display

[Text to display](http://www.example.com)

Can also be used to link to headers in the document:

Standard Markdown

[Standard Markdown](#standard-markdown)

Note: for the anchor:

• Start with a pound character "#"
• Lowercase everything in the header
• Replace spaces and punctuation with the dash "-" character.

Thus the header ## Standard Markdown is translated into: #standard-markdown

Quotes

This is a quote.
It can span multiple lines!

> This is a quote.
> It can span multiple lines!

Images

![name](http://www.example.com/image.jpg)

Displaying code

Code can be inline:

var example = "hello!";

`var example = "hello!";`

Or spanning multiple lines in a block:

var example = "hello!";
alert(example);

var example = "hello!";
alert(example);

Horizontal Rule

Horizontal Rules

To create a horizontal rule, use three or more asterisks (***), dashes (---), or underscores (___) on a line by themselves.

---

---

***
---

Extended Markdown configured on this server

https://mdit-py-plugins.readthedocs.io/en/latest/

Tables

Column 1	Column 2	Column 3
John	Doe	Male
Mary	Smith	Female

| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| John     | Doe      | Male     |
| Mary     | Smith    | Female   |

Or without aligning the columns...

Column 1	Column 2	Column 3
John	Doe	Male
Mary	Smith	Female

| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| John | Doe | Male |
| Mary | Smith | Female |

Definition list

Term 1

Definition 1 long form

second paragraph

Term 2 with inline markup

Definition 2a compact style

Definition 2b

Term 1
: Definition 1 long form

  second paragraph

Term 2 with *inline markup*
~ Definition 2a compact style
~ Definition 2b

Task lists

• An item that needs doing
• An item that is complete

- [ ] An item that needs doing
- [x] An item that is complete