Github Flavored Markdown

Tue Dec 22, 2015

This post illustrates the syntax of the most common uses of Github Flavored Markdown.

Additional Resources

The Github Mastering Markdown Guide provides a great introduction to Markdown.

Github Markdown Basics

Github Flavored Markdown Reference

Headings

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

Header 1

Header 2

Header 3

Header 4

Header 5
Header 6

Styling Text

*this is in italic*  and _so is this_

**this is in bold**  and __so is this__

***this is bold and italic***  and ___so is this___


<s>this is strike through text</s> and so is this ~~Mistaken text.~~

this is in italic and so is this

this is in bold and so is this

this is bold and italic and so is this

this is strike through text and so is this Mistaken text.

Lists

* an asterisk starts an unordered list
* and this is another item in the list
+ or you can also use the + character
- or the - character
  • an asterisk starts an unordered list
  • and this is another item in the list
  • or you can also use the + character
  • or the - character

NOTE: the CSS implemented with your website could alter the appearance of lists. For example, by default the Lanyon theme does not decorate lists with bullets. You will need to override list-style-type: none; within poole.css which is used with lanyon.css. I cover details on how to do that in the example project Lanyon CSS post.

Tables

    First Header   | Second Header
    -------------  | -------------
    *Content Cell* | Content Cell
    Content Cell   | **Content Cell**

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned |  $3   |
|   col 2 is    | centered      |   $12 |
|     col 1 is  | left-aligned  |    $1 |


Tables Are Cool
col 3 is right-aligned $3
col 2 is centered $12
col 1 is left-aligned $1

Block Quotes

> Block quote content

Block quote content

Inline Code formatting

Here is an `inline code` text.

Here is an inline code text.

Multiple Lines Code formatting

You can use triple backticks (```) to format text as its own distinct block.

Code Block
  if
  then
  else