UNPKG

3.68 kBMarkdownView Raw
1# Markdown
2
3Markdown 是一种轻量级标记语言,它以纯文本形式(*易读、易写、易更改*)编写文档,并最终以 HTML 格式发布。Markdown也可以理解为将以 MARKDOWN 语法编写的语言转换成 HTML 内容的工具。
4
5## 为什么要使用它
6* 它是易读(看起开舒服)、易写(语法简单)、易更改**纯文本**。处处体现着**极简主义**的影子。
7* 兼容 HTML,可以转换为 HTML 格式发布。
8* 跨平台使用。
9* 越来越多的网站支持 Markdown。
10* 更方便清晰的组织你的电子邮件。(Markdown-here, Airmail)
11* 摆脱 Word(我不是认真的)。
12
13如果不算扩展,Markdown 的语法绝对简单到让你爱不释手。
14
15Markdown 语法主要分为如下几大部分: 标题,段落,区块引用,代码区块,强调,列表,分割线,链接,图片,反斜杠 \,符号'`',表格。
16
17
18### 标题
19
20使用`#`,可表示1-6级标题。
21> \# 一级标题
22> \## 二级标题
23> \### 三级标题
24> \#### 四级标题
25> \##### 五级标题
26> \###### 六级标题
27
28效果:
29> # 一级标题
30> ## 二级标题
31> ### 三级标题
32> #### 四级标题
33> ##### 五级标题
34> ###### 六级标题
35
36
37### 段落
38段落的前后要有空行,所谓的空行是指没有文字内容。若想在段内强制换行的方式是使用**两个以上**空格加上回车(引用中换行省略回车)。
39
40
41### 区块引用
42在段落的每行或者只在第一行使用符号`>`,还可使用多个嵌套引用,如:
43> \> 区块引用
44> \>> 嵌套引用
45
46效果:
47> 区块引用
48>> 嵌套引用
49
50
51### 代码区块
52代码区块的建立是在每行加上4个空格或者一个制表符(如同写代码一样)。如
53普通段落:
54
55void main()
56{
57 printf("Hello, Markdown.");
58}
59
60代码区块:
61
62 void main()
63 {
64 printf("Hello, Markdown.");
65 }
66
67**注意**:需要和普通段落之间存在空行。
68
69### 强调
70在强调内容两侧分别加上`*`或者`_`,如:
71> \*斜体\*,\_斜体\_
72> \*\*粗体\*\*,\_\_粗体\_\_
73
74效果:
75> *斜体*,_斜体_
76> **粗体**,__粗体__
77
78### 列表
79使用`·``+`、或`-`标记无序列表,如:
80> \-(+\*) 第一项
81> \-(+\*) 第二项
82> \- (+\*)第三项
83
84**注意**:标记后面最少有一个 __空格____制表符__ 。若不在引用区块中,必须和前方段落之间存在空行。
85
86效果:
87> + 第一项
88> + 第二项
89> + 第三项
90
91有序列表的标记方式是将上述的符号换成数字,并辅以`.`,如:
92> 1 . 第一项
93> 2 . 第二项
94> 3 . 第三项
95
96效果:
97> 1. 第一项
98> 2. 第二项
99> 3. 第三项
100
101### 分割线
102分割线最常使用就是三个或以上`*`,还可以使用`-``_`
103
104### 链接
105链接可以由两种形式生成:**行内式****参考式**
106**行内式**
107> \[url\]\(https:://github.com/ymfe "Markdown"\)。
108
109效果:
110> [url](https:://github.com/ymfe "Markdown")
111
112
113### 图片
114添加图片的形式和链接相似,只需在链接的基础上前方加一个`!`
115
116### 反斜杠`\`
117相当于**反转义**作用。使符号成为普通符号。
118
119### 符号'`'
120起到标记作用。如:
121>\`ctrl+a\`
122
123效果:
124>`ctrl+a`
125
126### 表格
127
128`|`表示表格纵向边界,表头和表内容用`-`隔开,并可用`:`进行对齐设置,两边都有`:`则表示居中,若不加`:`则默认左对齐。
129
130```markdown
131|key | value |
132|:-----------:|------ |
133|title | ydoc |
134|content | ydoc |
135
136```
137
138效果:
139
140|key | value |
141|:-----------:|------ |
142|title | ydoc |
143|content | ydoc |