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
- dfad asfd asdg asdg a asdfasdga sdg a asdf asdg
- dfasgasdg sdfasdg a
- sdfasd fas dasfasgadgas
Text
wrap the text by stars
- italy, single stars:
* + sth + *
or_ + sth + _
- bold, double stars:
** + sth + **
or__ + sth + __
- deleted text:
~~text~~
- tag: use single (the key is at the leftside of number key 1) ` `` `
- Seperator, three or more any consecutive symbols:
***
-----
++++++
(must start with a new line)
hello dfasdf hello dsafds hello world dfasfdas
Blocks
- use
>
greater than symbols (allow embedded using) - use tripple back quote pair `
code
, specify the coding language right behind the first
`` - use four space or a tab
four space
ortab
hello
dfadga
@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);
Links, Images
- two ways: inline mode and reference mode.
-
use
[]()
and![]()
, google link , githubImage below: -
or
[content][id]
later specify the ids,[id]: www.baidu.com "baidu website"
- 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
-
start with
&
and end with;
, e.g., © & -
space:
 
 
 
 
example. -
some time, if you start with “1935. year”, which could be regarded as a list. Now you can use backslash to avoid it,
1935\. year
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}$
\[\sum^{j-1}_{k=0}{\widehat{\gamma}_{kj} z_k} \label{1}\]Others
- 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.
- font color and size
- create an outline
[TOC]
- footnote
[^keyword]
+[^keyword]: some descriptions about the notes
References
- [1]. http://blog.csdn.net/u011419965/article/details/50536937
- [2]. https://www.zybuluo.com/mdeditor
- [3]. http://wowubuntu.com/markdown/index.html