Skip to content

Markdown

Markdown Quick Reference

Headers (atx style)

# h1
## h2
### h3
#### h4
##### h5
###### h6

Headers (setext style)

Header 1
========
Header 2
--------

Blockquotes

> This is
> a blockquote
>
> > Nested
> > Blockquote

Unordered List {.row-span-2}

* Item 1
* Item 2
* item 3a
* item 3b

or

- Item 1
- Item 2

or

_ Item 1
+ Item 2

or

- [ ] Checkbox off
- [x] Checkbox on

Ordered List

1. Item 1
2. Item 2
a. Item 3a
b. Item 3b
[link](http://google.com)
[link][google]
[google]: http://google.com
<http://google.com>

Emphasis

*italic*
_italic_
**bold**
__bold__
`inline code`
~~struck out~~

Horizontal line

Hyphens

---

Asterisks

***

Underscores

___

Code

```javascript
console.log("This is a block code");
```
~~~css
.button {
border: none;
}
~~~
4 space indent makes a code block

Escaped code

Escaped code blocks can be done with more back ticks on the outside or a different symbol.

````markdown
```bash
echo hi
```
````
~~~markdown
```bash
echo hi
```
~~~

Inline code

`Inline code` has back-ticks around it

Tables

| Left column | Center column | Right column |
| :---------- | :-----------: | -----------: |
| Cell 1 | Centered | $1600 |
| Cell 2 | Cell 3 | $12 |

Simple style

Left column | Center column | Right column
:----------:|:-------------:|:-----------:
Cell 1 | Centered | $1600
Cell 2 | Cell 3 | $12

A markdown table generator: tableconvert.com

Images {.col-span-2}

![GitHub Logo](/images/logo.png)
![Alt Text](url)
[![GitHub Logo](/images/logo.png)](https://github.com/)
[![Alt Text](image_url)](link_url)

Reference style

![alt text][logo]
[logo]: /images/logo.png "Logo Title"

Backslash escapes

CharactersEscapeDescription
\\\Backslash
`\`Backtick
*\*Asterisk
_\_Underscore
{}\{\}Curly braces
[]\[\]Square brackets
()\(\)Parentheses
#\#Hash mark
+\+Plus sign
-\-Minus sign (hyphen)
.\.Dot
!\!Exclamation mark

{.show-header}