Skip to content

Writing Markdown

Github Guide

Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.

Headers

1
2
3
# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag

Emphasis

1
2
3
4
5
6
7
*This text will be italic*
_This will also be italic_

**This text will be bold**
__This will also be bold__

_You **can** combine them_

Lists

Unordered

1
2
3
4
* Item 1
* Item 2
  * Item 2a
  * Item 2b

Ordered

1
2
3
4
5
1. Item 1
1. Item 2
1. Item 3
   1. Item 3a
   1. Item 3b

Images

1
2
![GitHub Logo](/images/logo.png)
Format: ![Alt Text](url)

1
2
http://github.com - automatic!
[GitHub](http://github.com)

Blockquotes

1
2
3
4
As Kanye West said:

> We're living the future so
> the present is our past.

Inline code

1
2
I think you should use an
`<addr>` element here instead.