go back

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

Syntax guide

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

Headers

This is an

tag

This is an

tag

This is an

tag

Emphasis

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

  • Item 1
  • Item 2
    • Item 2.1
    • Item 2.2

Ordered

  1. Item 1
  2. Item 2
  3. Item 3
    1. Item 3.1
    2. Item 3.2

Images
GitHub Logo
Format: Alt Text

Links

http://github.com – automatic!
GitHub

Blockquotes

As Kanye West said:

We’re living the future so
the present is our past.

Inline code

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

  Edit this page