markdown基本语法
Markdown 是一种轻量级标记语言,排版语法简洁,让人们更多地关注内容本身而非排版。它使用易读易写的纯文本格式编写文档,可与 HTML 混编,可导出 HTML、PDF 以及本身的 .md 格式的文件。因简洁、高效、易读、易写,Markdown 被大量使用,如 Github、Wikipedia、简书等。
Markdown 标题语法
要创建标题,请在单词或短语前面添加井号 (#) 。# 的数量代表了标题的级别。例如,添加三个 # 表示创建一个三级标题 (<h3>) (例如:### My Header)。
1 | # 一级标题 |
Markdown 段落
要创建段落,请使用空白行将一行或多行文本进行分隔。
1 | 这是段落一一一 |
这是段落一一一
这是段落二二二二
这是段落三三三三
不要用空格(spaces)或制表符( tabs)缩进段落。
Markdown 换行语法
在一行的末尾添加两个或多个空格,然后按回车键,即可创建一个换行(<br>)
1 | 今夕何夕兮,搴舟中流。 |
今夕何夕兮,搴舟中流。
今日何日兮,得与王子同舟。
蒙羞被好兮,不訾诟耻。
心几烦而不绝兮,得知王子。
Markdown 强调语法
粗体(Bold)
要加粗文本,请在单词或短语的前后各添加两个星号(asterisks)或下划线(underscores)。如需加粗一个单词或短语的中间部分用以表示强调的话,请在要加粗部分的两侧各添加两个星号(asterisks)。
1 | 这段文本有**粗体** |
这段文本有粗体
斜体
要用斜体显示文本,请在单词或短语前后添加一个星号(asterisk)或下划线(underscore)。要斜体突出单词的中间部分,请在字母前后各添加一个星号,中间不要带空格。
1 | 这段文本有*斜体* |
这段文本有斜体
粗体(Bold)和斜体(Italic)
要同时用粗体和斜体突出显示文本,请在单词或短语的前后各添加三个星号或下划线。要加粗并用斜体显示单词或短语的中间部分,请在要突出显示的部分前后各添加三个星号,中间不要带空格。
1 | ***粗体(Bold)和斜体(Italic)*** |
粗体(Bold)和斜体(Italic)
Markdown 引用语法
基本使用
要创建块引用,请在段落前添加一个 > 符号。
1 | > 去年今日此门中,人面桃花相映红。____崔护《题都城南庄》 |
去年今日此门中,人面桃花相映红。____崔护《题都城南庄》
多个段落的块引用
块引用可以包含多个段落。为段落之间的空白行添加一个 > 符号。
1 | > 三五七言 |
三五七言
李白〔唐代〕
秋风清,秋月明,
落叶聚还散,寒鸦栖复惊。
相思相见知何日?此时此夜难为情!
入我相思门,知我相思苦,
长相思兮长相忆,短相思兮无穷极,
早知如此绊人心,何如当初莫相识。
嵌套块引用
块引用可以嵌套。在要嵌套的段落前添加一个 >> 符号。
1 | > 苏轼〔宋代〕 |
苏轼〔宋代〕
丙辰中秋,欢饮达旦,大醉,作此篇,兼怀子由。
明月几时有?把酒问青天。
不知天上宫阙,今夕是何年。
我欲乘风归去,又恐琼楼玉宇,高处不胜寒。
起舞弄清影,何似在人间。(何似 一作:何时;又恐 一作:惟 / 唯恐)
转朱阁,低绮户,照无眠。
不应有恨,何事长向别时圆?人有悲欢离合,月有阴晴圆缺,此事古难全。(长向 一作:偏向)
但愿人长久,千里共婵娟。
带有其它元素的块引用
块引用可以包含其他 Markdown 格式的元素。并非所有元素都可以使用,你需要进行实验以查看哪些元素有效。
1 | > **葛藟** |
葛藟
佚名〔先秦〕
绵绵葛藟,在河之浒。终远兄弟,谓他人父。谓他人父,亦莫我顾。
绵绵葛藟,在河之涘。终远兄弟,谓他人母。谓他人母,亦莫我有。
绵绵葛藟,在河之漘。终远兄弟,谓他人昆。谓他人昆,亦莫我闻。
Markdown 列表语法
可以将多个条目组织成有序或无序列表。
有序列表
要创建有序列表,请在每个列表项前添加数字并紧跟一个英文句点。数字不必按数学顺序排列,但是列表应当以数字 1 起始。
1 | 1. 苹果 |
- 苹果
- 香蕉
- 橘子
- 西瓜
- 荔枝
无序列表
要创建无序列表,请在每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。缩进一个或多个列表项可创建嵌套列表。
1 | - 苹果 |
- 苹果
- 香蕉
- 橘子
- 西瓜
- 荔枝
在列表中嵌套其他元素
段落
1 | - 苹果 |
- 苹果
这是一个红苹果- 香蕉
- 橘子
- 西瓜
- 荔枝
引用块
1 | - 苹果 |
渲染效果如下:
- 苹果
这是一个红苹果
- 香蕉
- 橘子
- 西瓜
- 荔枝
代码块
1 | 1. 苹果 |
- 苹果
苹果 苹果
- 橘子
- 奇异果
Markdown 代码语法
如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:
1 | `printf()` 函数 |
printf() 函数
代码区块
代码区块使用 4 个空格或者一个制表符(Tab 键)。
<html>
<head>
</head>
</html>
也可以用 ``` 包裹一段代码,并指定一种语言(也可以不指定):
1 | alert('Hello World!'); |
Markdown 分隔线语法
在单独一行上使用三个或多个星号 (***)、破折号 (—) 或下划线 (___) ,并且不能包含其他内容。
1 | *** |
#Markdown 链接语法
超链接Markdown语法代码:[超链接显示名](超链接地址 "超链接title")
对应的HTML代码:<a href="超链接地址" title="超链接title">超链接显示名</a>
这是一个 链接
Markdown 图片语法
插入图片Markdown语法代码:。
对应的HTML代码:<img src="图片链接" alt="图片alt" title="图片title">
Markdown 表格
Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
语法格式如下:
1 | | 表头 | 表头 | |
显示结果如下:
| 表头 | 表头 |
|---|---|
| 单元格 | 单元格 |
| 单元格 | 单元格 |
Markdown 转义字符语法
Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:
1 | **文本加粗** |
文本加粗
** 正常显示星号 **
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
1 | \ 反斜线 |
Markdown 内嵌 HTML 标签
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 ,如:
1 | 使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑 |
使用 Ctrl+Alt+Del 重启电脑