Markdown cheatsheet demo

November 4, 2015   

This is Markdown Cheatsheet Demo. This page is hosted by GitHub and is using it’s default markdown and code highlighter. Please check the raw content of this file for the markdown usage.

Typography Elements in One

Let’s start with a informative paragraph. This text is bolded. But not this one! How about italic text? Cool right? Ok, let’s combine them together. Yeah, that’s right! I have code to highlight, so ThisIsMyCode(). What a nice! Good people will hyperlink away, so here we go or http://www.example.com.

Headings H1 to H6

H1 Heading

H2 Heading

H3 Heading

H4 Heading

H5 Heading
H6 Heading

Footnote

Let’s say you have text that you want to refer with a footnote, you can do that too! This is an example for the footnote number one 1. You can even add more footnotes, with link! 2

LateX:

This is an online latex: \( \pi = 4 \sum_{i=0}^{\infty} \frac{(-1)^{i}}{2i+1} \;\;\; \& \;\;\; G_{\mu\nu} = 8\pi T_{\mu\nu} \)

This is an equation:

Blockquote

Start by doing what’s necessary; then do what’s possible; and suddenly you are doing the impossible. –Francis of Assisi

NOTE: This theme does NOT support nested blockquotes.

Awesome font icons:

Here are some icon’s from font awesome. They are pretty awesome!


List Items

  1. First order list item
  2. Second item
  • Unordered list can use asterisks
  • Or minuses
  • Or pluses

Code Blocks

var s = "JavaScript syntax highlighting";
alert(s);
/* css synthax highlighting */ 
#container {
    float: left;
    margin: 0 -240px 0 0;
    width: 100%;
}

Another way of highlighting

#include<iostream>
#include<vector>

int main()
/* Multiple
   line comment
 */
try {
    std::vector<int> vec{3,4,3,1};
    int i{vec.at(4)};
}
//An exception handler, catches std::out_of_range
catch(std::out_of_range& e) {
    std::cerr<<"Accessing a non-existent element: "<<e.what()<<'\n';
}
catch(std::exception& e) {
    std::cerr<<"Exception thrown: "<<e.what()<<'\n';
}

With no language:

No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.

And finally directly including and highlighting a source code from source file:

###### Comment #######
def clean_text(text,replace_dict=None,words_replacer=None):

    text = text.lower()

    if replace_dict is not None:
        for k, v in replace_dict.items():
            text = re.sub(k,v,text)

    if words_replacer is not None:
        text = text.split(' ')
        text = words_replacer.replace(text)
        text = ' '.join(text)

    return text

Table

Table 1: With Alignment

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1

Table 2: With Typography Elements

Markdown Less Pretty
Still renders nicely
1 2 3

Horizontal Line

The HTML <hr> element is for creating a “thematic break” between paragraph-level elements. In markdown, you can create a <hr> with any of the following:

  • ___: three consecutive underscores
  • ---: three consecutive dashes
  • ***: three consecutive asterisks

renders to:




Media

YouTube Embedded Iframe

Image

Nature

  1. Footnote number one yeah baby! 

  2. A footnote you can link to - click here!