Github Flavored Markdown - Syntax guide

markdown zig

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

Headers

This is an <h1> tag

This is an <h2> tag

This is an <h6> 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 2a
    • Item 2b

Ordered

  1. Item 1
  2. Item 2
  3. Item 3
    1. Item 3a
    2. Item 3b

Images

Vincent van Gogh (1853 - 1890), Paris, May 1887

Links

http://github.com - automatic! GitHub

Blockquotes

As Carl Sagan said:

If you wish to make an apple pie from scratch, you must first invent the universe.

Inline code

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

GitHub Flavored Markdown

Syntax highlighting

Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

You can also simply indent your code by four spaces:

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

(Be aware the code won't be highlighted because the language cannot be identified by prism)

Task Lists

  • @mentions, #refs, links, formatting, and tags supported
  • list syntax required (any unordered or ordered list supported)
  • this is a complete item
  • this is an incomplete item

Tables

First Header Second Header
Content from cell 1 Content from cell 2
Content in the first column Content in the second column

Automatic linking for URLs

Any URL (like http://www.github.com/) will be automatically converted into a clickable link.

Strikethrough

Any word wrapped with two tildes (like this) will appear crossed out.

← All posts