Markdown Formats

Typography

Text can be bold, italic, or strikethrough.

Markdown Syntax:

Text can be **bold**, _italic_, or ~~strikethrough~~.

Link to another page

Link to page with new tab

Markdown Syntax:

[Link to another page](another-page)
[Link to page with new tab](https://www.google.com/){:target="_blank"}

There should be whitespace between paragraphs.

There should be whitespace between paragraphs. We recommend including a README, or a file with information about your project.

Markdown Syntax:

# Header 1
## Header 2
## Header 3
### Header 4
#### Header 5
##### Header 6
###### Header 7

Header 1

This is a normal paragraph following a header. GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.

Header 2

This is a blockquote following a header.

When something is important enough, you do it even if the odds are not in your favor.

Header 3

// Javascript code with syntax highlighting.
var fun = function lang(l) {
  dateformat.i18n = require('./lang/' + l)
  return true;
}

# Ruby code with syntax highlighting
GitHubPages::Dependencies.gems.each do |gem, version|
  s.add_dependency(gem, "= #{version}")
end

Header 4

  • This is an unordered list following a header.
  • This is an unordered list following a header.
  • This is an unordered list following a header.
Header 5
  1. This is an ordered list following a header.
  2. This is an ordered list following a header.
  3. This is an ordered list following a header.
Header 6
head1 head two three
ok good swedish fish nice
out of stock good and plenty nice
ok good ‘oreos’ hmm
ok good ‘zoute’ drop yumm

Markdown Syntax:

| head1        | head two          | three |
|:-------------|:------------------|:------|
| ok           | good swedish fish | nice  |
| out of stock | good and plenty   | nice  |
| ok           | good `oreos`      | hmm   |
| ok           | good `zoute` drop | yumm  |

There’s a horizontal rule below this.

Markdown Syntax:

---

Here is an unordered list:

  • Item foo
  • Item bar
  • Item baz
  • Item zip

Markdown Syntax:

*   Item foo
*   Item bar
*   Item baz
*   Item zip

And an ordered list:

  1. Item one
  2. Item two
  3. Item three
  4. Item four

Markdown Syntax:

1.  Item one
1.  Item two
1.  Item three
1.  Item four

And a nested list:

  • level 1 item
    • level 2 item
    • level 2 item
      • level 3 item
      • level 3 item
  • level 1 item
    • level 2 item
    • level 2 item
    • level 2 item
  • level 1 item
    • level 2 item
    • level 2 item
  • level 1 item

Markdown Syntax:

- level 1 item
  - level 2 item
  - level 2 item
    - level 3 item
    - level 3 item
- level 1 item
  - level 2 item
  - level 2 item
  - level 2 item
- level 1 item
  - level 2 item
  - level 2 item
- level 1 item

Nesting an ol in ul in an ol

  • level 1 item (ul)
    1. level 2 item (ol)
    2. level 2 item (ol)
      • level 3 item (ul)
      • level 3 item (ul)
  • level 1 item (ul)
    1. level 2 item (ol)
    2. level 2 item (ol)
      • level 3 item (ul)
      • level 3 item (ul)
    3. level 4 item (ol)
    4. level 4 item (ol)
      • level 3 item (ul)
      • level 3 item (ul)
  • level 1 item (ul)

Markdown Syntax:

- level 1 item (ul)
  1. level 2 item (ol)
  1. level 2 item (ol)
    - level 3 item (ul)
    - level 3 item (ul)
- level 1 item (ul)
  1. level 2 item (ol)
  1. level 2 item (ol)
    - level 3 item (ul)
    - level 3 item (ul)
  1. level 4 item (ol)
  1. level 4 item (ol)
    - level 3 item (ul)
    - level 3 item (ul)
- level 1 item (ul)

And a task list

  • Hello, this is a TODO item
  • Hello, this is another TODO item
  • Goodbye, this item is done

Markdown Syntax:

- [ ] Hello, this is a TODO item
- [ ] Hello, this is another TODO item
- [x] Goodbye, this item is done

Small image

Markdown Syntax:

![](https://assets-cdn.github.com/images/icons/emoji/octocat.png)

Large image

Markdown Syntax:

![](https://guides.github.com/activities/hello-world/branching.png)

Definition lists can be used with HTML syntax.

Name
Godzilla
Born
1952
Birthplace
Japan
Color
Green

Markdown Syntax:

<dl>
<dt>Name</dt>
<dd>Godzilla</dd>
<dt>Born</dt>
<dd>1952</dd>
<dt>Birthplace</dt>
<dd>Japan</dd>
<dt>Color</dt>
<dd>Green</dd>
</dl>

Multiple description terms and values

Term
Brief description of Term
Longer Term
Longer description of Term, possibly more than one line
Term
First description of Term, possibly more than one line

Second description of Term, possibly more than one line

Term1
Term2
Single description of Term1 and Term2, possibly more than one line
Term1
Term2
First description of Term1 and Term2, possibly more than one line

Second description of Term1 and Term2, possibly more than one line

Markdown Syntax:

Term
: Brief description of Term

Longer Term
: Longer description of Term,
  possibly more than one line

More code

Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.