Markdown的语法
Markdown
是一种轻量级的标记语言,用于编写易于阅读和编写的文档。
标题
在 Markdown
中支持六级标题,在若干个 #
后面跟上标题内容即可成为标题,写法如下
1 | # 一级标题 |
注意:
- 标准写法要求在
#
与标题内容之间有一个空格Notion
只支持到三级标题
列表
在 Markdown
中大致分为三种列表:无序列表、有序列表以及 TODO。
无序列表
无序列表的形式如下:
- 足球
- 篮球
- 乒乓球
可以看到在列表项前有一个黑色原点,我们将其称之为子弹头,所以无需列表也可以称为 bullet list
。
要制作一个无序列表,只需要在列表项前加上 -
、*
或 +
号即可,我一般使用 -
号,所以上述的列表项是这么写的
1 | - 足球 |
注意:在
-
和内容之间需要有一个空格
此外列表项还可以嵌套,例如:
- 中国
- 北京
- 上海
- 南昌
- 日本
- 东京
嵌套的语法也很简单,使用两个空格或者 Tab
键进行缩进即可,如下
1 | - 中国 |
我们看到城市的子项相对于国家有两个空格的缩进,所以城市会变为国家的子项。
有序列表
有的时候我们的列表是有顺序关系的,这个时候我们使用有序列表,如下
- 打开浏览器
- 输入 bilibili 的网址
- 开始摸鱼
要制作一个有序列表,我们只需要在列表项前加上数字就行,比如上面的列表项的写法如下
1 | 1. 打开浏览器 |
注意:
数字后面有一个
.
,并且.
与内容之间需要有一个空格列表项必须是连续的,否则会出现未知的问题
列表项之间不要有空行,比如下面的写法是不推荐的
1
2
3
4
5 1. 打开浏览器
2. 输入 bilibili 的网址
3. 开始摸鱼
同样,有序列表也是可以嵌套的,同样添加对应的缩进即可
- 起床
- 睁开眼睛
- 关掉闹钟
- 在睡一会儿
- 刷牙
- 做早饭
上面有序列表的写法如下:
1 | 1. 起床 |
另外,无序列表与有序列表之间可以相互嵌套,比如
- 数学家排名
- 牛顿
- 高斯
- 黎曼
- 物理学家排名
- 牛顿
- 爱因斯坦
- 麦克斯韦
写法如下:
1 | - 数学家排名 |
超链接
当我们点击超链接时,我们会跳转到一个网页,例如点击这里你会跳转到百度,那么如何制作一个超链接。语法如下:
1 | [内容](跳转地址) |
比如上面的超链接的写法如下
1 | [点击这里](https://www.baidu.com) |
注意:
- 如果你是在
Typora
打开的,你需要按下Ctrl(Windows)/Command(Mac)
然后点击才会跳转- 链接的地址需要加上
http://
或者https://
,不要只写www.baidu.com
,这样时无效的
脚注
脚注一般用来对于文本的说明,可以作为内容的注释以及论文的引用,一般位于文档的尾部。我们在需要注释的文档后面加上 [^text]
,其中 text
是右上角显示的文字,我们一般使用数字序号,比如 [^1]
,然后再文档的最后加上解释说明 [^text]: note.
。举个例子,当你把鼠标放置在右上角的 1
上面就可以看到脚注内容。
窗前明月光,疑是地上床^1。
上面的写法为:
1 | 窗前明月光,疑是地上床[^1]。 |
然后我们在文档的最后加上脚注的内容
1 | [^1]: 李白《静夜思》 |
这样就做成了一个脚注。
文本修饰
通过一些特定的符号,我们可以对文本进行修饰,例如加粗,倾斜,删除线等等效果。
加粗
在需要加粗的文字两边分别加上两个星号 **
,即可对内容进行加粗
1 | **加粗** |
倾斜
在需要倾斜的文字两边分别加上一个星号 *
,即可对内容进行倾斜
1 | *倾斜* |
加粗并倾斜
如果我们需要同时对文字进行加粗和倾斜,那我们就需要在文字两边加上三个星号 ***
1 | ***加粗并倾斜*** |
删除线
在文字的两边加上 ~~
就会出现删除线,例如不要 998,只要98,写法如下
1 | 不要 ~~998~~,只要 98 |
引用
上面我的一些注意事项都是放在一个引用框内
这是一段引用的文字。
我们只需要在引用的内容前面加上 >
即可出现引用框
1 | > 这是一段引用的文字。 |
引用的本意是为了引用别人的内容,比如论文、书本中的一段话
窗前明月光,疑是地上霜。
静夜思《李白》
代码
内联代码
使用反引号System.out.println("Hello, World!");
包围代码片段。
1 | `System.out.println("Hello, World!");` |
代码块
使用三个反引号 (`````) 开始和结束代码块,并指定语言以启用高亮。
1 | ```java |
水平线
使用三个连字符 (---
) 创建水平线。
1 | --- |
表格
在很多的时候我们都会在笔记中应用表格,例如
科目 | 成绩 |
---|---|
语文 | 100 |
数学 | 100 |
它的写法如下
1 | | 科目 | 成绩 | |
第一行表示表头,第二行是固定的格式,必须这样写,不过其中的 -
不要求一定是三个,可以是任意多个,不过要在两个以上,然后后面的内容就是表格的内容了,|
与 |
之间的内容就是表格项。
有的时候我们会有合并单元项的要求
班级 | 排名 |
---|---|
6001 | 1 |
6002 | 2 |
6003 | |
6004 | 4 |
要实现这样的效果就得借助于 HTML
了,它的写法如下
1 | <table> |
图片
如果需要在文档中插入图片,通过以下的语法:
1 |  |
它与超链接的语法很相似,区别在于图片需要加上 !
。
上面的语法中图片描述不是必须的,只有图片地址是必须的,下面是引用图片的简单写法:
1 |  |
关于图片的地址又分为相对地址和绝对地址。
相对地址
相对地址指的是图片的地址相对当前文档而言的,例如假设又如下的目录结构
1 | . |
index.md
是需要插入图片的文档,pic1.png
与文档处于同一目录,image
文件夹与文档处于同一目录,并且该文件夹下包含图片 pic2.png
,现在我们可以通过如下的方法在文档中引用这两张图片
1 |  |
其中的 ./
表示当前目录,所以 ./pic1.png
就表示当前目录下的 pic1.png
文件,而 ./image/pic2.png
就表示当前目录下的 image
文件夹中的 pic2.png
文件。
绝对地址
通过绝对地址访问不用关心图片相对于文档的相对位置,例如 pic3.png
放置在桌面上,我们就可以直接通过如下语法在文档中引用该图片,不论文档在任何地方
1 |  |
其中 ~
表示用户的家目录。
另一种绝对地址是 url
链接
1 |  |
效果如下