markdown

Mastering Markdown

Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on GitHub platform.

What you will lean:

  • How the Markdown format makes styled collaborative editing easy
  • How Markdown differs from traditional formatting approaches
  • How to use Markdown to format text
  • How to leverage GitHub’s automatic Markdown rendering
  • How to apply GitHub’s unique Markdown extensions

What is Markdown?

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

You can use Markdown most places around GitHub:

  • Gists
  • Comments in Issues and Pull Requests
  • Files with the .md or .markdown extension

For more information, see “Writing on GitHub” in the GitHub Help.

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