听说Markdown写文档很方便,参照所给帮助文档测试一下
标题
Markdown中,如果一段文字被定义为标题,只要在这段文字前加#就行。如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
以此类推,建议在井号后加一个空格,这是最标准的Markdown语法。
列表
在Markdown下,列表的显示只需要在文字前加上- 或 *即可变为无序列表,有序列表则直接在文字前加1. 2. 3., 符号要和文字之间加上一个字符的空格。
无序列表 有序列表
* 1 1.
* 2 2.
* 3 3.
如果要控制列表的层级,对于无需列表则需要在符号”-“前使用空格,对于有序列表在数字前加空格。
- list1
- list2
- sublist1
- sublist2
引用
在文中需要一段其它别处的句子,那么就要用的格式。
> 引用
要注意符合和文本间的空格。
图片与链接
插入链接与插入图片很像,区别在于一个!号。
插入链接 [baidu](http://www.baidu.com "option title here)
插入图片 ![yunbaidu][http://www.baidu.com//mouse.png]
在引用在加链接, 第一个中括号添加需要添加的文字,第二个中括号中是引用链接的id。之后在引用中,使用id加链接。如下:
[百度][0]
[0]: http://www.baidu.com "option title here"
百度
在文中直接引用链接,直接使用尖括号,把链接加入到尖括号中就可以实现,如下:
http://example.com/ or address@example.com
粗体与斜体
粗体语法在文字头和尾加两个*, 斜体语法在文字头和尾加一个。 如果在文字前后加三个星号,则表示粗体+斜体。
如: ** 粗体内容 **
* 斜体内容 *
表格
可以使用冒号来定义表格的对齐方式, 如下:
| Tables | Are | Cool |
|----------|:----------:|---------:|
| row test | 漫非意,似题测试| ceshi|
代码框
用tab键或空格起始的段落, 会被认为是代码块,如下:
import numpy as np
arr = np.array([2, 3, 4, 5])
如果在一个行内需要引用代码, 只需反引号`引用起来即可, 如
print(r’Hello world’)`
代码块与语法高亮
在需要高亮的代码块的前一行与后一行使用三个反引号”`”。同时第一行反引号后面表明代码块所使用的语言。如:
int main(void)
{
print("Hello world!");
}
换行
空出单独的一行可以换行,或者每一行后面至少空两个空格换行。
分割线
分割线只需另起一行,连续输入三个星号”*”。
快捷键
win7下常用快捷键如下:
粗体 Ctrl+B
斜体 Ctrl+I
引用 Ctrl+Q
代码 Ctrl+K
超链接 Ctrl+L
图片 Ctrl+G
撤销 Ctrl+Z
无序列表 Ctrl+U
有序列表 Ctrl+O
横线 Ctrl+R