Introduction


Markdown is one of the markup languages that is simple but enriched to use.

Use GitHub Pages, it is preferable to switch to kramdown.

You can go through the [markdown tutorial] (http://markdowntutorial.com/) to understand the simplicty of it.

In this website, kramdown is used since it is hosed on Git Pages. (Here is the sytax and quick reference)

Below, we will have two versions. But if you want to host it on GitHub Pages, kramdown is flavored.

  1. markdown (Some of them will not rendered rightly here.)

  2. kramdown


Create fenced code block (markdown)

```
Here is the fenced code block
```

Here is the fenced code block

Create fenced code block (kramdown)

~~~
Here is the fenced code block for kramdown
~~~
Here is the fenced code block for kramdown

Sytax highlighting for code (markdown)

```python
def hello_word():
    print(“Hello, world!”);
```

def hello_word():
    print("Hello, world!");

Sytax highlighting for code (kramdown)

~~~ python
def hello_word():
    print("Hello, world!");
~~~
def hello_word():
    print("Hello, world!");

Sytax highlighting for code (pygment)

{% highlight python %}
def hello_word():
print(“Hello, world!”);
{% endhighlight %}


def hello_word():
    print("Hello, world!");

Display image

![Image on Wiki]  (https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg)

![Image on Wiki] (https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg)


Display image (kramdown)

![Image on Wiki](https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg)

Image on Wiki

No space between ] and (


[Google] (https://www.google.com)

[Google] (https://www.google.com)


[Google](https://www.google.com)

Google

No space between ] and (


[Google][Google link]

[Google link]: https://www.google.com

Google


Comment

[comment]: <> (This is one line of comment.) 

Where the comment is This is one line of comment.


Reference

  1. markdown tutorial in Chinese

  2. markdown guides @ guides.gitgub

  3. markdown syntax @ github

  4. markdown cheetsheet @ github

  5. markdown syntax @ daringfireball

  6. markdown cheetsheet @ squarespace

  7. nice markdown cheetsheet @ jonschlinkert


Icons is provided by FindIcons.com