Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
175 lines (152 sloc) 3.92 KB

Contents

Typography

Headings (top)

<h1> = # Header
<h2> = ## Header
<h3> = ### Header
<h4> = #### Header
<h5> = ##### Header
<h6> = ###### Header

Paragraphs (top)

This is the first paragraph.

And this is the second separated by a blank line.

Bold Text (top)

In this sentence the word **bold** is tagged with <strong> tags.

Italicized Text (top)

In this sentence the word *italics* is tagged with <em> tags.

Blockquotes (top)

/***********************************
* Standard Blockquote
***********************************/
> This is a block
> of really cool
> text

/***********************************
* Nested Blockquote
***********************************/
> Here is a block
> that contains
>> a nest!
> and I'm back out of the nest...

Lists (top)

/***********************************
* Unordered List
***********************************/
- list item 1
- list item 2
    - sublist 1
    - sublist 2
- list item 3

/***********************************
* Ordered List
***********************************/
1. list item 1
2. list item 2
    1. sublist 1
    2. sublist 2
3. list item 3

Links

This is a line with an [inline link to Google](http://www.google.com "Google").
This line has reference links for [Google] [1] and [GitHub] [2].

    [1]: http://www.google.com "Google"
    [2]: http://www.github.com "GitHub"

Tables

Standard Table (top)

| Header 1 | Header 2     |
| -------- | ------------ |
| Content  | More content |

Code

Inline Code (top)

Here is some inline `code` that will be formatted appropriately

Code Blocks (top)

/***********************************
* Standard Code Block
***********************************/
Tab or four spaces for standard code block syntax:
    void replace(){
        //lots of really cool code in here
    }

/******************************************************
* GitHub Flavored Code Block with Syntax Highlighting
*******************************************************/
Three ticks before and after the code block & specify language:
    ```language
    void replace(){
        //lots of really cool code in here
    }
    ```

Images

Inline Images (top)

![alt text](path/to/img.jpg "Title")

Image References (top)

![alt text][id]

    [id]: path/to/img.jpg "Title"

Other

Horizontal Rules (top)

- - -

Backslash Escape Characters (top)

\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+   plus sign
-   minus sign (hyphen)
.   dot
!   exclamation mark