File README.md added (mode: 100644) (index 0000000..5ad5cf6) |
|
1 |
|
<div id="markdown-headline" /> |
|
2 |
|
|
|
3 |
|
# Markdown 指北 (Markdown Tutorial) |
|
4 |
|
|
|
5 |
|
## 概述 (Overview) |
|
6 |
|
|
|
7 |
|
Markdown 是一种轻量级标记语言,创于2004年,关键人物:[John Gruber] 与 [Aaron Swartz]。它的设计旨在可以使人们以易读、易写的纯文本格式写作,并且可以很容易的转换为 PDF、HTML、DOC 或 XHTML 等其他文件格式。Markdown 常应用于格式化自述文件和在线论坛写消息。 |
|
8 |
|
|
|
9 |
|
由于其简单易用的特性,使其成为世界上最流行的轻量级标记语言之一,并在各类平台上获得了广泛支持,如 GitHub,Bitbucket 等。基础语法支持很好,但各平台的衍生版本语法不尽相同,对 Markdown 扩展及其它语法支持和渲染效果有差异化。 |
|
10 |
|
|
|
11 |
|
[John Gruber]: https://en.wikipedia.org/wiki/John_Gruber |
|
12 |
|
|
|
13 |
|
[Aaron Swartz]: https://en.wikipedia.org/wiki/Aaron_Swartz |
|
14 |
|
|
|
15 |
|
--- |
|
16 |
|
|
|
17 |
|
## 目录 (Table of Contents) |
|
18 |
|
|
|
19 |
|
#### [基础语法 (Basic Syntax)](#anchor-bsyn) |
|
20 |
|
|
|
21 |
|
1. [标题 (Headings)](#11-标题-headings) |
|
22 |
|
2. [字体样式 (Decorated Fonts)](#12-字体样式-decorated-fonts) |
|
23 |
|
* 粗体 (Bold) |
|
24 |
|
* 斜体 (Italic) |
|
25 |
|
* 删除线 (Strikethrough) |
|
26 |
|
* 粗体加斜体 (Bold and Italic) |
|
27 |
|
* 粗体加删除线 (Bold and Strikethrough) |
|
28 |
|
* 斜体加删除线 (Italic and Strikethrough) |
|
29 |
|
3. [换行 (Line Breaks)](#13-换行-line-breaks) |
|
30 |
|
4. [文字段落 (Paragraphs)](#14-文字段落-paragraphs) |
|
31 |
|
5. [水平线 (Horizontal Rules)](#15-水平线-horizontal-rules) |
|
32 |
|
6. [块引用 (Blockquotes)](#16-块引用-blockquotes) |
|
33 |
|
7. [列表 (Lists)](#17-列表-lists) |
|
34 |
|
- 有序列表 (Ordered Lists) |
|
35 |
|
- 无序列表 (Unordered Lists) |
|
36 |
|
- 嵌套列表 (Nested Lists) |
|
37 |
|
8. [超链接 (Links)](#18-超链接-Links) |
|
38 |
|
- 行内样式链接 (Inline-style Links) |
|
39 |
|
- 引用样式链接 (Reference-style Links) |
|
40 |
|
- 自动链接 (Automatic Links) |
|
41 |
|
- 锚点 (Anchors) |
|
42 |
|
9. [图片 (Images)](#19-图片-images) |
|
43 |
|
- 行内样式图片 (Inline-style Images) |
|
44 |
|
- 引用样式图片 (Reference-style Images) |
|
45 |
|
10. [代码 (Codes)](#110-代码-codes) |
|
46 |
|
- 行内代码 (Inline-style Codes) |
|
47 |
|
- 代码块 (Code Blocks) |
|
48 |
|
11. [跳脱字符 (Escaping Characters)](#111-跳脱字符-escaping-characters) |
|
49 |
|
|
|
50 |
|
#### [扩展语法 (Extended Syntax)](#anchor-esyn) |
|
51 |
|
|
|
52 |
|
1. [表格 (Tables)](#21-表格-tables) |
|
53 |
|
2. [标题ID (Heading IDs)](#22-标题ID-heading-ids) |
|
54 |
|
3. [脚注 (Footnotes)](#23-脚注-footnotes) |
|
55 |
|
4. [代码块及语法高亮 (Code Blocks and Syntax Highlighting)](#24-代码块及语法高亮-code-blocks-and-syntax-highlighting) |
|
56 |
|
5. [任务列表 (Task Lists)](#25-任务列表-task-lists) |
|
57 |
|
|
|
58 |
|
#### [参考 (References)](#ref) |
|
59 |
|
|
|
60 |
|
#### [打赏或赞助 (Donation)](#dona) |
|
61 |
|
|
|
62 |
|
--- |
|
63 |
|
|
|
64 |
|
<div id='anchor-bsyn' /> |
|
65 |
|
|
|
66 |
|
## 基础语法 (Basic Syntax) |
|
67 |
|
|
|
68 |
|
#### 1.1 标题 (Headings) |
|
69 |
|
|
|
70 |
|
使用字符井号 ‘#’,空格,然后紧接标题名称来设置标题。支持六个级别的标题,字符 ‘#’ 的数量表示相应级别的标题。 |
|
71 |
|
|
|
72 |
|
示例: |
|
73 |
|
|
|
74 |
|
# H1 一级标题 |
|
75 |
|
## H2 二级标题 |
|
76 |
|
### H3 三级标题 |
|
77 |
|
#### H4 四级标题 |
|
78 |
|
##### H5 五级标题 |
|
79 |
|
###### H6 六级标题 |
|
80 |
|
|
|
81 |
|
渲染效果如下: |
|
82 |
|
|
|
83 |
|
# H1 一级标题 |
|
84 |
|
## H2 二级标题 |
|
85 |
|
### H3 三级标题 |
|
86 |
|
#### H4 四级标题 |
|
87 |
|
##### H5 五级标题 |
|
88 |
|
###### H6 六级标题 |
|
89 |
|
|
|
90 |
|
[回到目录](#目录-table-of-contents) |
|
91 |
|
|
|
92 |
|
--- |
|
93 |
|
|
|
94 |
|
#### 1.2 字体样式 (Decorated Fonts) |
|
95 |
|
|
|
96 |
|
a. **粗体** (Bold) |
|
97 |
|
|
|
98 |
|
在文字左右分别用两个同样字符 ‘*’ 或 ‘_’ 围起来表示应用粗体。 |
|
99 |
|
|
|
100 |
|
b. **斜体** (Italic) |
|
101 |
|
|
|
102 |
|
在文字左右分别用单个字符 ‘*’ 或 ‘_’ 围起来表示应用斜体。 |
|
103 |
|
|
|
104 |
|
c. **删除线** (Strikethrough) |
|
105 |
|
|
|
106 |
|
在文字左右分别用两个同样字符 ‘~’ 围起来表示应用删除线。 |
|
107 |
|
|
|
108 |
|
d. **粗体加斜体** (Bold and Italic) |
|
109 |
|
|
|
110 |
|
粗体加斜体,为嵌套应用。分解为 ‘**’ 和 ‘*’ 。 |
|
111 |
|
|
|
112 |
|
e. **粗体加删除线** (Bold and Strikethrough) |
|
113 |
|
|
|
114 |
|
粗体加删除线,为嵌套应用。分解为 ‘~~’ 和 ‘**’ 。 |
|
115 |
|
|
|
116 |
|
f. **斜体加删除线** (Italic and Strikethrough) |
|
117 |
|
|
|
118 |
|
斜体加删除线,为嵌套应用。分解为 ‘~~’ 和 ‘*’ 。 |
|
119 |
|
|
|
120 |
|
示例: |
|
121 |
|
|
|
122 |
|
**这是加粗的文字** |
|
123 |
|
*这是倾斜的文字* |
|
124 |
|
~~这是加删除线的文字~~ |
|
125 |
|
***这是斜体加粗的文字*** |
|
126 |
|
~~**这是粗体加删除线的文字**~~ |
|
127 |
|
~~*这是斜体加删除线的文字*~~ |
|
128 |
|
|
|
129 |
|
|
|
130 |
|
渲染效果如下: |
|
131 |
|
|
|
132 |
|
**这是加粗的文字** |
|
133 |
|
*这是倾斜的文字* |
|
134 |
|
~~这是加删除线的文字~~ |
|
135 |
|
***这是斜体加粗的文字*** |
|
136 |
|
~~**这是粗体加删除线的文字**~~ |
|
137 |
|
~~*这是斜体加删除线的文字*~~ |
|
138 |
|
|
|
139 |
|
[回到目录](#目录-table-of-contents) |
|
140 |
|
|
|
141 |
|
--- |
|
142 |
|
|
|
143 |
|
#### 1.3 换行 (Line Breaks) |
|
144 |
|
|
|
145 |
|
在行尾使用两个空格加回车来表示换行。 |
|
146 |
|
|
|
147 |
|
示例: |
|
148 |
|
|
|
149 |
|
虽然此行文字不太长,但我要在此处换行 |
|
150 |
|
这是换行后的第二行。 |
|
151 |
|
|
|
152 |
|
渲染效果如下: |
|
153 |
|
|
|
154 |
|
虽然此行文字不太长,但我要在此处换行 |
|
155 |
|
这是换行后的第二行。 |
|
156 |
|
|
|
157 |
|
[回到目录](#目录-table-of-contents) |
|
158 |
|
|
|
159 |
|
--- |
|
160 |
|
|
|
161 |
|
#### 1.4 文字段落 (Paragraphs) |
|
162 |
|
|
|
163 |
|
在要设为段落文字下方,使用空行来将其设为段落。 |
|
164 |
|
|
|
165 |
|
示例: |
|
166 |
|
|
|
167 |
|
这是第一个段落 |
|
168 |
|
|
|
169 |
|
这个第二个段落 |
|
170 |
|
|
|
171 |
|
|
|
172 |
|
渲染效果如下: |
|
173 |
|
|
|
174 |
|
这是第一个段落 |
|
175 |
|
|
|
176 |
|
这是第二个段落 |
|
177 |
|
|
|
178 |
|
[回到目录](#目录-table-of-contents) |
|
179 |
|
|
|
180 |
|
--- |
|
181 |
|
|
|
182 |
|
#### 1.5 水平线 (Horizontal Rules) |
|
183 |
|
|
|
184 |
|
使用三个或者三个以上字符 ‘-’ ,‘*’ 或 ‘_’ 都可以创建水平线。 |
|
185 |
|
|
|
186 |
|
示例: |
|
187 |
|
|
|
188 |
|
--- |
|
189 |
|
*** |
|
190 |
|
___ |
|
191 |
|
|
|
192 |
|
三种方式其渲染效果等同如下: |
|
193 |
|
|
|
194 |
|
--- |
|
195 |
|
|
|
196 |
|
[回到目录](#目录-table-of-contents) |
|
197 |
|
|
|
198 |
|
--- |
|
199 |
|
|
|
200 |
|
#### 1.6 块引用 (Blockquotes) |
|
201 |
|
|
|
202 |
|
在文字段落前加符号 ‘>’ 表示块引用。块引用可以嵌套,标示符号数量代表其嵌套层级。 |
|
203 |
|
|
|
204 |
|
示例: |
|
205 |
|
|
|
206 |
|
>这是引用的内容 |
|
207 |
|
>>这是嵌套引用的内容 |
|
208 |
|
>>>***这是另一个嵌套引用的内容*** |
|
209 |
|
>>>>>>## 这是最深层嵌套引用的内容 |
|
210 |
|
|
|
211 |
|
渲染效果如下: |
|
212 |
|
|
|
213 |
|
>这是引用的内容 |
|
214 |
|
>>这是嵌套引用的内容 |
|
215 |
|
>>>***这是另一个嵌套引用的内容*** |
|
216 |
|
>>>>>>## 这是最深层嵌套引用的内容 |
|
217 |
|
|
|
218 |
|
__注:__ _块引用可以结合多种其它元素使用。_ |
|
219 |
|
|
|
220 |
|
[回到目录](#目录-table-of-contents) |
|
221 |
|
|
|
222 |
|
--- |
|
223 |
|
|
|
224 |
|
#### 1.7 列表 (Lists) |
|
225 |
|
|
|
226 |
|
a. **有序列表** (Ordered Lists) |
|
227 |
|
|
|
228 |
|
在列表条目前使用数字和符号 ‘.’ 表示有序列表 ,列表条目和点之间要有空格。 |
|
229 |
|
|
|
230 |
|
1. 列表内容 |
|
231 |
|
2. 列表内容 |
|
232 |
|
3. 列表内容 |
|
233 |
|
|
|
234 |
|
渲染效果如下: |
|
235 |
|
|
|
236 |
|
1. 列表内容 |
|
237 |
|
2. 列表内容 |
|
238 |
|
3. 列表内容 |
|
239 |
|
|
|
240 |
|
|
|
241 |
|
b. **无序列表** (Unordered lists) |
|
242 |
|
|
|
243 |
|
在列表条目前使用单个符号 ‘-’ , ‘+’ 或 ‘*’ 表示无序列表,列表条目和符号之间要有空格。 |
|
244 |
|
|
|
245 |
|
- 列表内容 |
|
246 |
|
+ 列表内容 |
|
247 |
|
* 列表内容 |
|
248 |
|
|
|
249 |
|
渲染效果如下: |
|
250 |
|
|
|
251 |
|
- 列表内容 |
|
252 |
|
+ 列表内容 |
|
253 |
|
* 列表内容 |
|
254 |
|
|
|
255 |
|
|
|
256 |
|
c. **列表嵌套** (Nested Lists) |
|
257 |
|
|
|
258 |
|
TAB缩进或4个空格都起到嵌套作用。 |
|
259 |
|
|
|
260 |
|
1. 一级有序列表内容 |
|
261 |
|
- 二级无序列表内容 |
|
262 |
|
- 二级无序列表内容 |
|
263 |
|
|
|
264 |
|
此处插入一个段落。 |
|
265 |
|
**多种***元素*。 |
|
266 |
|
|
|
267 |
|
- 二级无序列表内容 |
|
268 |
|
2. 一级有序列表内容 |
|
269 |
|
1. 二级有序列表内容 |
|
270 |
|
2. 二级有序列表内容 |
|
271 |
|
>这里是块引用。 |
|
272 |
|
|
|
273 |
|
**注**: *在有些编辑器中TAB健已被设置为代表4个空格输出。* |
|
274 |
|
|
|
275 |
|
渲染效果如下: |
|
276 |
|
|
|
277 |
|
1. 一级有序列表内容 |
|
278 |
|
- 二级无序列表内容 |
|
279 |
|
- 二级无序列表内容 |
|
280 |
|
|
|
281 |
|
此处插入一个段落。 |
|
282 |
|
**多种***元素*。 |
|
283 |
|
|
|
284 |
|
- 二级无序列表内容 |
|
285 |
|
2. 一级有序列表内容 |
|
286 |
|
1. 二级有序列表内容 |
|
287 |
|
2. 二级有序列表内容 |
|
288 |
|
>这里是块引用。 |
|
289 |
|
|
|
290 |
|
**注:** *列表可以结合多种其它元素使用。* |
|
291 |
|
|
|
292 |
|
[回到目录](#目录-table-of-contents) |
|
293 |
|
|
|
294 |
|
--- |
|
295 |
|
|
|
296 |
|
#### 1.8 超链接 (Links) |
|
297 |
|
|
|
298 |
|
a. **行内样式链接** (Inline-style Links) |
|
299 |
|
|
|
300 |
|
[超链接名](超链接地址 "超链接标题title") |
|
301 |
|
|
|
302 |
|
示例: |
|
303 |
|
|
|
304 |
|
[此处为行内样式链接](https://bing.com) |
|
305 |
|
|
|
306 |
|
[此处为具有标题title的行内样式链接](http://google.com "权利与傲慢") |
|
307 |
|
|
|
308 |
|
渲染效果如下: |
|
309 |
|
|
|
310 |
|
[此处为行内样式链接](https://bing.com) |
|
311 |
|
|
|
312 |
|
[此处为具有title的行内样式链接](https://google.com "权利与傲慢") |
|
313 |
|
|
|
314 |
|
b. **引用样式链接** (Reference-style Links) |
|
315 |
|
|
|
316 |
|
引用样式链接分为两个文本块: |
|
317 |
|
|
|
318 |
|
`引用文本块:[超链接名][引用目标]` |
|
319 |
|
|
|
320 |
|
`被引用文本块:[被引用目标]: </超链接地址>/ "/'/(超链接title)/'/"` |
|
321 |
|
|
|
322 |
|
**注**: *被引用文本块可以放在文档任何位置。如果超链接名与被引用目标文本内容相同,引用目标的括号及符号内的引用目标文本内容就可以省略,否则引用目标和被引用目标的文本内容必须相同。用来围住超链接的符号 ‘<>’ 可以省略。地址超链接标题titile可以用符号 ‘"’ , ‘'’ 或 ‘()’ 围起来。* |
|
323 |
|
|
|
324 |
|
示例: |
|
325 |
|
|
|
326 |
|
[此处为引用样式链接][任意非大小写敏感文本或数字] |
|
327 |
|
|
|
328 |
|
[任意非大小写敏感文本或数字]: https://www.facebook.com '面子的成本' |
|
329 |
|
|
|
330 |
|
[我和引用目标同名] |
|
331 |
|
|
|
332 |
|
[我和引用目标同名]: <https://www.twitter.com> "道场" |
|
333 |
|
|
|
334 |
|
渲染效果如下: |
|
335 |
|
|
|
336 |
|
[此处为引用样式链接][任意非大小写敏感文本] |
|
337 |
|
|
|
338 |
|
[任意非大小写敏感文本]: https://www.facebook.com '面子的成本' |
|
339 |
|
|
|
340 |
|
[我和引用目标同名] |
|
341 |
|
|
|
342 |
|
[我和引用目标同名]: <https://www.twitter.com> "道场" |
|
343 |
|
|
|
344 |
|
c. **自动链接** (Automatic Links) |
|
345 |
|
|
|
346 |
|
示例: |
|
347 |
|
|
|
348 |
|
欢迎使用域名样例网站: <http://www.example.com> |
|
349 |
|
|
|
350 |
|
如有疑问请联系:<iana@iana.org> |
|
351 |
|
|
|
352 |
|
直接使用链接地址同样有效 http://www.example.com |
|
353 |
|
|
|
354 |
|
|
|
355 |
|
|
|
356 |
|
渲染效果如下: |
|
357 |
|
|
|
358 |
|
欢迎使用域名样例网站:<http://www.example.com> |
|
359 |
|
|
|
360 |
|
如有疑问请联系: <iana@iana.org> |
|
361 |
|
|
|
362 |
|
直接使用链接地址同样有效: http://www.example.com |
|
363 |
|
|
|
364 |
|
d. **锚点** (Anchors) |
|
365 |
|
|
|
366 |
|
锚点,也叫命名锚记,是页面内的定位器,通过链接访问可以直接跳转到页面的锚点部位。 |
|
367 |
|
|
|
368 |
|
在markdown中标题可以直接作为锚点,其它处可用html标记来生成锚点。 |
|
369 |
|
|
|
370 |
|
html锚点: |
|
371 |
|
|
|
372 |
|
<a name="anchor1">你在找我吗?</a> |
|
373 |
|
或任何其它具有id的html标签,如: |
|
374 |
|
<div id="anchor2">你还在找我吗?</div> |
|
375 |
|
<a id="anchor3">你真的在找我吗?</a> |
|
376 |
|
|
|
377 |
|
渲染效果如下: |
|
378 |
|
|
|
379 |
|
html锚点: |
|
380 |
|
|
|
381 |
|
<a name="anchor1">你在找我吗?</a> |
|
382 |
|
|
|
383 |
|
或任何其它具有id的html标签,如: |
|
384 |
|
<div id="anchor2">你还在找我吗?</div> |
|
385 |
|
<a id="anchor3">你真的在找我吗?</a> |
|
386 |
|
|
|
387 |
|
|
|
388 |
|
锚点引用方式如下: |
|
389 |
|
|
|
390 |
|
[超链接名称](#锚点) |
|
391 |
|
|
|
392 |
|
**注**:*当标题作为锚点在引用时,锚点内容中大写字母要转为小写;中文不变;半角标点符号要直接去掉(虽然在有的 markdwon 中可以不去掉也有效);全角标点符号各 markdown 中解析有差异,不建议使用;空白字符要替换为符号 ‘-’ 。* |
|
393 |
|
|
|
394 |
|
示例: |
|
395 |
|
|
|
396 |
|
[跳转到此小结标题处](#18-超链接-links) |
|
397 |
|
[我在找你啊](#anchor1) |
|
398 |
|
[我还在找你啊](#anchor2) |
|
399 |
|
[我真的在找你啊](#anchor3) |
|
400 |
|
|
|
401 |
|
渲染效果如下: |
|
402 |
|
|
|
403 |
|
[跳转到此小结标题处](#18-超链接-links) |
|
404 |
|
[我在找你啊](#anchor1) |
|
405 |
|
[我还在找你啊](#anchor2) |
|
406 |
|
[我真的在找你啊](#anchor3) |
|
407 |
|
|
|
408 |
|
[回到目录](#目录-table-of-contents) |
|
409 |
|
|
|
410 |
|
--- |
|
411 |
|
|
|
412 |
|
#### 1.9 图片 (Images) |
|
413 |
|
|
|
414 |
|
a. **行内样式图片** (Inline-style Images) |
|
415 |
|
|
|
416 |
|
![图片alt](图片地址 "图片title") |
|
417 |
|
|
|
418 |
|
图片alt就是当图片无法显示时的替代文字。 |
|
419 |
|
图片title是图片的标题,当鼠标移到图片上时显示的内容。 |
|
420 |
|
title非必需。 |
|
421 |
|
|
|
422 |
|
b. **引用样式图片** (Reference-style Images) |
|
423 |
|
|
|
424 |
|
![图片alt][引用目标] |
|
425 |
|
|
|
426 |
|
[被引用目标] </图片地址>/ "/'/(图片title)/'/" |
|
427 |
|
|
|
428 |
|
**注**: *引用样式图片与引用样式链接类似,就多一个符号 ‘!’。* |
|
429 |
|
|
|
430 |
|
示例: |
|
431 |
|
|
|
432 |
|
![beautiful sky](http://www.ottawafamilyliving.com/writeable/editor_uploads/images/images/manalone.jpg "璀璨星空") |
|
433 |
|
|
|
434 |
|
![beautiful sky](./images/manalone.jpg "璀璨星空") |
|
435 |
|
|
|
436 |
|
![beautiful sky][beau-sky] |
|
437 |
|
|
|
438 |
|
[beau-sky]:./images/manalone.jpg (璀璨星空") |
|
439 |
|
|
|
440 |
|
渲染效果如下:(三种方式的效果相同) |
|
441 |
|
|
|
442 |
|
![beautiful][beau-skyone] |
|
443 |
|
|
|
444 |
|
[beau-skyone]: ./images/manalone.jpg "璀璨星空" |
|
445 |
|
|
|
446 |
|
[回到目录](#目录-table-of-contents) |
|
447 |
|
|
|
448 |
|
--- |
|
449 |
|
|
|
450 |
|
#### 1.10 代码 (codes) |
|
451 |
|
|
|
452 |
|
a. **行内代码** (Inline-style Codes) |
|
453 |
|
|
|
454 |
|
代码两边分别用一个符号反引号 ‘`’ 围起来。 |
|
455 |
|
|
|
456 |
|
`代码内容` |
|
457 |
|
|
|
458 |
|
**注**:*当代码内容中有反引号时,在代码内容两边使用两个反引号。* |
|
459 |
|
|
|
460 |
|
示例: |
|
461 |
|
|
|
462 |
|
`echo "Hello World!"` |
|
463 |
|
``create `database` example;`` |
|
464 |
|
|
|
465 |
|
渲染效果如下: |
|
466 |
|
|
|
467 |
|
`echo "Hello World!"` |
|
468 |
|
``create `database` example;`` |
|
469 |
|
|
|
470 |
|
|
|
471 |
|
b. **代码块** (Code blocks) |
|
472 |
|
|
|
473 |
|
在每行代码行前使用TAB缩进或4个空格。如果在列表中就必须使用两个TAB缩进或8个空格。 |
|
474 |
|
|
|
475 |
|
渲染效果如下: |
|
476 |
|
|
|
477 |
|
#!/bin/bash |
|
478 |
|
function say_hello(){ |
|
479 |
|
echo "Hello World!"; |
|
480 |
|
} |
|
481 |
|
say_hello |
|
482 |
|
|
|
483 |
|
**注**: *在扩展语法中,将介绍另一种代码块语法,并能实现指定语法高亮。* |
|
484 |
|
|
|
485 |
|
[回到目录](#目录-table-of-contents) |
|
486 |
|
|
|
487 |
|
--- |
|
488 |
|
|
|
489 |
|
#### 1.11 跳脱字符 (Escaping Characters) |
|
490 |
|
|
|
491 |
|
为了显示功能性字符,要取消其功能性作用,就需对相应字符进行转义。转义字符为 ‘\’。 |
|
492 |
|
|
|
493 |
|
示例: |
|
494 |
|
|
|
495 |
|
\*\*二级标题 |
|
496 |
|
\- 无序列表 |
|
497 |
|
\-\-\- 水平线 |
|
498 |
|
|
|
499 |
|
渲染效果如下: |
|
500 |
|
|
|
501 |
|
\*\*二级标题 |
|
502 |
|
\- 无序列表 |
|
503 |
|
\-\-\- 水平线 |
|
504 |
|
|
|
505 |
|
**可以被转义的字符表** |
|
506 |
|
|
|
507 |
|
| 字符 | 名称 | 英文对照 | |
|
508 |
|
| ---- | ------ | ------------------- | |
|
509 |
|
| \ | 反斜线 | backslash | |
|
510 |
|
| ` | 反引号 | tick mark | |
|
511 |
|
| * | 星号 | asterisk | |
|
512 |
|
| _ | 下划线 | underscore | |
|
513 |
|
| {} | 大括号 | curly braces | |
|
514 |
|
| [] | 中括号 | brackets | |
|
515 |
|
| () | 括号 | parentheses | |
|
516 |
|
| # | 井号 | pound sign | |
|
517 |
|
| + | 加号 | plus sign | |
|
518 |
|
| - | 减号 | minus sign (hyphen) | |
|
519 |
|
| . | 点 | dot | |
|
520 |
|
| ! | 感叹号 | exclamation mark | |
|
521 |
|
| \| | 管道 | pipe | |
|
522 |
|
|
|
523 |
|
**注**: *为了在表单中显示管道,对其进行转义* `\|`*,也可以直接使用其HTML代码 `|`,也可以达到同样效果。* |
|
524 |
|
|
|
525 |
|
[回到目录](#目录-table-of-contents) |
|
526 |
|
|
|
527 |
|
--- |
|
528 |
|
|
|
529 |
|
<div id='anchor-esyn' /> |
|
530 |
|
|
|
531 |
|
## 扩展语法 (Extended Syntax) |
|
532 |
|
|
|
533 |
|
#### 2.1 表格 (Tables) |
|
534 |
|
|
|
535 |
|
| 表头 | 表头 | 表头 | |
|
536 |
|
| :----- | :----: | -----: | |
|
537 |
|
| 表单元 | 表单元 | 表单元 | |
|
538 |
|
|
|
539 |
|
1. 字符 ‘|’ 分隔表列。 |
|
540 |
|
2. 字符 ‘-’ 三个或三个以上表示其上一行为表头。 |
|
541 |
|
3. 字符 ‘:’ 在左边表示左对齐,右边为右对齐。两边都有,表示居中。缺省为左对齐。 |
|
542 |
|
4. 字符 ‘|’ 在列表每行首尾可以省略。 |
|
543 |
|
|
|
544 |
|
|
|
545 |
|
示例: |
|
546 |
|
|
|
547 |
|
Markdown 综合属性 |
|
548 |
|
|
|
549 |
|
| 特点 | 应用的网络平台 | 编辑器 | 关联软件及语言 | |
|
550 |
|
| ---- | -------------- | ------------ | -------------- | |
|
551 |
|
| 轻量 | github | VScode | Git | |
|
552 |
|
| 简单 | WordPress | Atom | Pandoc | |
|
553 |
|
| 易学 | Stack Overflow | Markdown pad | HTML | |
|
554 |
|
|
|
555 |
|
[Github]: https://github.com/ |
|
556 |
|
[WordPress]: https://wordpress.com/ |
|
557 |
|
[Stack Overflow]: https://stackoverflow.com/ |
|
558 |
|
[VScode]: https://code.visualstudio.com/?wt.mc_id=DX_841432 |
|
559 |
|
[Atom]: https://atom.io/ |
|
560 |
|
[MarkdownPad]: http://markdownpad.com/ |
|
561 |
|
[Git]: https://git-scm.com/ |
|
562 |
|
[Pandoc]: http://www.pandoc.org/ |
|
563 |
|
[HTML]: https://www.w3.org/html/ |
|
564 |
|
|
|
565 |
|
效果如下: |
|
566 |
|
|
|
567 |
|
Markdown 综合属性 |
|
568 |
|
|
|
569 |
|
| 特点 | 应用的网络平台 | 编辑器 | 关联软件及语言 | |
|
570 |
|
| ---- | ---------------- | ------------- | -------------- | |
|
571 |
|
| 轻量 | [Github] | [VScode] | [Git] | |
|
572 |
|
| 简单 | [WordPress] | [Atom] | [Pandoc] | |
|
573 |
|
| 易学 | [Stack Overflow] | [MarkdownPad] | [HTML] | |
|
574 |
|
|
|
575 |
|
[Github]: https://github.com/ |
|
576 |
|
[WordPress]: https://wordpress.com/ |
|
577 |
|
[Stack Overflow]: https://stackoverflow.com/ |
|
578 |
|
[VScode]: https://code.visualstudio.com/?wt.mc_id=DX_841432 |
|
579 |
|
[Atom]: https://atom.io/ |
|
580 |
|
[MarkdownPad]: http://markdownpad.com/ |
|
581 |
|
[Git]: https://git-scm.com/ |
|
582 |
|
[Pandoc]: http://www.pandoc.org/ |
|
583 |
|
[HTML]: https://www.w3.org/html/ |
|
584 |
|
|
|
585 |
|
**注**: *可以在表单中结合其它元素。* |
|
586 |
|
|
|
587 |
|
[回到目录](#目录-table-of-contents) |
|
588 |
|
|
|
589 |
|
--- |
|
590 |
|
|
|
591 |
|
#### 2.2 标题ID (Heading IDs) |
|
592 |
|
|
|
593 |
|
标题ID本质上说是属于HTML标题标签的id属性,其具有唯一性,方便引用于其它操作。正如我们在链接中的锚点中引用一样,当我们可以设置标题引用目标,就不用去转换大小写字母等等繁琐步骤了。 |
|
594 |
|
|
|
595 |
|
标题部分: #### 标题内容 {#自定义id名称} |
|
596 |
|
|
|
597 |
|
链接标题: \[链接名称\]\(#自定义id名称\) |
|
598 |
|
|
|
599 |
|
示例: |
|
600 |
|
|
|
601 |
|
#### 样例标题 {#soeasyid} |
|
602 |
|
|
|
603 |
|
[一点就到样例标题了](#soeasyid) |
|
604 |
|
|
|
605 |
|
渲染效果如下: |
|
606 |
|
|
|
607 |
|
<h4 id="soeasyid">样例标题</h4> |
|
608 |
|
|
|
609 |
|
<a href="#soeasyid">一点就到样例标题了</a> |
|
610 |
|
|
|
611 |
|
**注**: *示例生成的两行html代码分别为:`<h4 id="soeasyid">样例标题</h4>`,`<a href="#soeasyid">一点就到样例标题了</a>`。 |
|
612 |
|
|
|
613 |
|
[回到目录](#目录-table-of-contents) |
|
614 |
|
|
|
615 |
|
--- |
|
616 |
|
|
|
617 |
|
#### 2.3 脚注 (Footnotes) |
|
618 |
|
|
|
619 |
|
脚注类似于引用样式链接,也分为两部分: |
|
620 |
|
|
|
621 |
|
引用部分: [^引用目标] |
|
622 |
|
|
|
623 |
|
被引用部分:[^引用目标]: 被引用文本内容 |
|
624 |
|
|
|
625 |
|
**注**: *被引用文本的段落可以通过使用TAB行首缩进或4个空格持续添加。* |
|
626 |
|
|
|
627 |
|
示例: |
|
628 |
|
|
|
629 |
|
此处有一个脚注,[^1] 这里还有一个更长的脚注。[^bignote] |
|
630 |
|
|
|
631 |
|
[^1]: 1.这是第一个脚注。 |
|
632 |
|
|
|
633 |
|
[^bignote]: 2.这是一个包含多个段落和代码的脚注。 |
|
634 |
|
|
|
635 |
|
使用TAB缩进或四个空格包含这些段落到脚注中。 |
|
636 |
|
|
|
637 |
|
`{ my code }` |
|
638 |
|
|
|
639 |
|
您可以持续添加您需要的文本段落。 |
|
640 |
|
|
|
641 |
|
渲染效果如下: |
|
642 |
|
|
|
643 |
|
<p>此处有一个脚注,<a href="#fn1" class="footnote-ref" id="fnref1"><sup>1</sup></a> 这里还有一个更长的脚注。<a href="#fn2" class="footnote-ref" id="fnref2"><sup>2</sup></a></p> |
|
644 |
|
<hr /> |
|
645 |
|
<ol> |
|
646 |
|
<li id="fn1"><p>这是第一个脚注。<a href="#fnref1" class="footnote-back">↩</a></p></li> |
|
647 |
|
<li id="fn2"><p>这是一个包含多个段落和代码的脚注。</p> |
|
648 |
|
<p>使用TAB缩进或四个空格包含这些段落到脚注中。</p> |
|
649 |
|
<p><code>{ my code }</code></p> |
|
650 |
|
<p>您可以持续添加您需要的文本段落。<a href="#fnref2" class="footnote-back">↩</a></p></li> |
|
651 |
|
</ol> |
|
652 |
|
|
|
653 |
|
[回到目录](#目录-table-of-contents) |
|
654 |
|
|
|
655 |
|
--- |
|
656 |
|
|
|
657 |
|
#### 2.4 代码块及语法高亮 (Code Blocks and Syntax Highlighting) |
|
658 |
|
|
|
659 |
|
在基础语法中,我们在每行代码前使用TAB或4个空格来表示代码块。扩展语法中我们还可以在代码段首尾分别用三个字符 ‘`’ 或 ‘~’ 围起来,且各自独占一行。 |
|
660 |
|
|
|
661 |
|
如果我们在代码块语法的首个三个字符后指定代码语言,还能实现相应代码的高亮效果。 |
|
662 |
|
|
|
663 |
|
``` |
|
664 |
|
代码... |
|
665 |
|
代码... |
|
666 |
|
代码... |
|
667 |
|
``` |
|
668 |
|
|
|
669 |
|
示例: |
|
670 |
|
|
|
671 |
|
```bash |
|
672 |
|
#!/bin/bash |
|
673 |
|
function say_hello(){ |
|
674 |
|
echo "Hello World!"; |
|
675 |
|
} |
|
676 |
|
say_hello(); |
|
677 |
|
``` |
|
678 |
|
|
|
679 |
|
渲染效果如下: |
|
680 |
|
|
|
681 |
|
```bash |
|
682 |
|
#!/bin/bash |
|
683 |
|
function say_hello(){ |
|
684 |
|
echo "Hello World!"; |
|
685 |
|
} |
|
686 |
|
say_hello |
|
687 |
|
``` |
|
688 |
|
|
|
689 |
|
[回到目录](#目录-table-of-contents) |
|
690 |
|
|
|
691 |
|
--- |
|
692 |
|
|
|
693 |
|
#### 2.5 任务列表 (Task Lists) |
|
694 |
|
|
|
695 |
|
任务列表使用字符 ‘-’ ,‘[ ]’ 和列表条目三个部分来表示一行列表,三个部分之间要有空格。第二个部分 ‘[ ]’ 表示未选任务列表, ‘[x]’ 表示已选任务列表。 |
|
696 |
|
|
|
697 |
|
示例: |
|
698 |
|
|
|
699 |
|
- [x] 已选列表条目1 |
|
700 |
|
- [x] 已选列表条目2 |
|
701 |
|
- [ ] 未选列表条目3 |
|
702 |
|
|
|
703 |
|
渲染效果如下: |
|
704 |
|
|
|
705 |
|
- [x] 已选列表条目1 |
|
706 |
|
- [x] 已选列表条目2 |
|
707 |
|
- [ ] 未选列表条目3 |
|
708 |
|
|
|
709 |
|
[回到目录](#目录-table-of-contents) |
|
710 |
|
|
|
711 |
|
--- |
|
712 |
|
|
|
713 |
|
<div id="ref" /> |
|
714 |
|
|
|
715 |
|
## 参考 (References) |
|
716 |
|
|
|
717 |
|
[Markdown](https://en.wikipedia.org/wiki/Markdown) wiki百科 |
|
718 |
|
|
|
719 |
|
[Markdown Guide](https://www.markdownguide.org) Matt Cone |
|
720 |
|
|
|
721 |
|
[Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) Adam Pritchard |
|
722 |
|
|
|
723 |
|
--- |
|
724 |
|
|
|
725 |
|
<div id="dona" /> |
|
726 |
|
|
|
727 |
|
## 打赏或赞助 (Donation) |
|
728 |
|
|
|
729 |
|
以上内容都是本小虾收集与整理的,如果您觉得有帮助,欢迎您对我说:“来,喝瓶水!”。 |
|
730 |
|
|
|
731 |
|
[来,喝瓶水!](https://www.paypal.me/haojiangzhu/5 '来,喝瓶水!') |
|
732 |
|
|
|
733 |
|
--- |
|
734 |
|
|
|
735 |
|
[回到页首](#markdown-headline) |