Markdown 文档常见语法
作者本人是前端码农一枚,随着行业的内卷,渐渐地也不得不跳出 “舒适圈”,开始向 “全干”工程师靠拢了。本次选择的目标那自然是最经典的 java 语言啦,那么本篇内容是首先来整理下 Markdown 文档常见的语法规范,这里只记录常用的 Markdown 语法,不用很多,够用就行
后续也会持续更新 java 语言的学习笔记,作者大大水平有限,有不正确或遗漏的地方欢迎各位大佬指正,让我们一起进步吧!
1. 标题
标题包括一到六级标题,一级标题语法为 #+空格+标题 ,二级标题为##+空格+标题。以此类推,想展示几级标题就在前面写几个 "#" 即可。注意,最多 6 级哦!展示效果如下:
-
一级标题
-
二级标题
-
三级标题
-
四级标题
-
五级标题
-
六级标题
2. 斜体
斜体的表示语法有两种,第一种是将内容包裹在两个 "*" 之中,第二种是将内容包裹在两个 "_" 中间。斜体效果可以用来展示特殊意义的文字内容,展示效果如下:
- 这里是文字
- 这里是文字
3. 粗体
粗体的展示语法是将内容包裹在两个 "**" 之中,可以用来标记重要的文本内容,展示效果如下:
- 这里是文字
除此之外,Markdown 的文档语法也可以互相套用,比如斜体的内容可以被粗体的包裹,反之,粗体的内容也可以被斜体包裹。但实际上这两者表现出来的效果是一样的,如下:
- 斜体+粗体 这里是文字
- 粗体+斜体 这里是文字
4. 中划线
中划线的展示语法是将内容包裹在两个 "~~" 中间,可以用来标识被删除的文本内容,展示效果如下:
这里是文字
5. 图片链接
图片链接的展示语法分三种,分别是 "!+[图片描述]+(图片路径)"、"!+[图片描述]+(图片路径 "title")"
6. 代码块
对于广大程序员来讲,Markdown 文档提供的代码块语法无疑是这个工具最大的亮点,这也是为什么我们在学习开发语言前首先要了解 Markdown 文档语法的原因,后续我们的笔记也会以为 Markdown 文档的形式记录
代码块的语法同样也是分两种,类似于开发语言中的注释,代码块语法同样分为单行代码块与多行代码块。
单行代码块的展示语法为将代码块放在两个 "`"中间,并且单行代码块可以书写在文本中间(**该符号位于 Tab 键的上方)
多行代码快的展示语法为将代码块放在两个 "```" 中间
展示效果如下:
- 这是一段文本
int a = 10;这是一段文本 int b = 20;
7. 分割线
分割线有助于我们合理的分割文档内容,使文档看起来更简洁明了,其语法为 ">---",展示效果如下
8. 引用
引用语法我个人认为是在 Markdown 文档中跟代码块同样至关重要的语法,如果说代码块语法的存在能够让我们的代码内容更突出,那么引用语法就是可以让我们的文字内容更引人注目,比如现在这段话就是放在引用中的,目的就是要让人一目了然。
引用的语法为 ">+空格+引用内容",展示效果如下:
这里是一段文字,这里是一段文字
9. 列表
列表分为有序列表和无序列表,其中有序列表的语法为 "序号+点(.)+空格",而无序列表则有多种语法形式,分别为 "*+空格"、"加号(+)+空格" 以及 "中划线(-)+空格"。展示效果如下:
- 无序列表(.)
- 无序列表(+)
- 无序列表(-)
- 有序列表
- 有序列表
- 有序列表
10. 表格
表格同样是一个强大的功能,可以帮助我们有条理的将某些知识点记录下来,方便我们查看对比,它的语法为 "-|-|-",其中 "-" 表示每个单元格的内容,而 "|" 则是单元格的分割标识。其展示效果如下:
姓名|年龄|性别
小明|18|男
小花|15|女
同时我们可以使用 ":" 来控制单元格内容的对齐方式,其中 ":-" 代表左对齐,"-:" 代表右对齐,":-:" 代表居中对齐,效果如下:
:姓名|:年龄:|性别:
:小明|:18:|男:
:小花|:15:|女: