Markdown Basis

Headers

hash symbols + space + "text" + space + hash symbols, but the suffix hashes are optional. h1-#, h2-##

Lists

unordered list, use symbols asterisk + space + content , alternatively, u can use symbol like - or + besides * ordered list, use numbers, following by a point, 1.+ space + content

Text

wrap the text by stars

hello dfasdf hello dsafds hello world dfasfdas


Blocks

@requires_authorization
def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None
int a = 5;
int b = 6;
max_num = max (a,b);
  1. two ways: inline mode and reference mode.
  1. auto-link: <website address> baidu http://www.baidu.com zhen.zhao@outlook.com

Table

under typora, we can use shoot-cut com/ctrl + t. or, | item0 | item1 | item2 |

| ----- |:-----:|:-----:|

| colu0 | colu0 | colu0 |

Functions Description
sdsklearn.cluster.KMeans K-Means clustering
sdsklearn.cluster.DBSCAN Perform DBSCAN clustering from vector array for distance matrix

Special Symbols

Latex Equations

Exactly like what u did in LaTex environments. Usually, just use $some equation$ and $$equation block$$ .

refer to MathJax for more details. (\label{} and \ref{})

  $E=Mc^2$ $\frac{1}{N} \sum_{n=0}^N \alpha_n$ $x = \frac{-b\pm\sqrt{b^2-4ac}}{2a}$

Others

  1. Markdown can smoothly support the html syntax. so you can do a lot more through html tags
    • font color and size <font face='Arial' size=12 color=gray>hello</font> <font face='黑体' size=5 color=#00ff92>hello</font>
    • commnets <!-- comments -->
    • iframe, image size, etc.
  2. create an outline [TOC]
  3. footnote [^keyword] + [^keyword]: some descriptions about the notes

References

Table of Contents