走进 Markdown

初识

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。常用于以下但不限于:

  • 博客
  • README文档
  • Jupyter
  • 笔记软件(Typora、Obsidian、Notion、语雀等)

首先在vscode安装插件(在侧边栏,或按 Ctrl + Shift + X):

  • Markdown All in One(必装)
  • Markdown Preview Enhanced(必装,用于预览效果)
  • markdownlint(可选,用于检查规范与否的问题,养成习惯)
  1. 创建一个md文件。
    0967a771-6dc7-4098-bebd-3999fb4efaa0.png

  2. 右上角打开预览
    4faba5a7-1dd9-4e85-b50c-4dbbd05c8081.png

  3. 码字完成后按 Ctrl + S 即可显示预览状态。

常用语法

Markdown的语法极其简单,一个钟即可学完七七八八,对应的文件格式为 .md


1. 多级标题

md最多支持六级标题,每一个井号(#)代表一级,空格接一个标题。按照规范,一级标题只能出现一次,为文章的总标题,而其余的则可以出现多次。

1
2
3
4
5
6
7
8
9
10
11
# 这是一级标题

## 这是二级标题

### 这是三级标题

#### 这是四级标题

##### 这是五级标题

###### 这是六级标题

效果:
af2ac2e1-8e40-412c-b938-454f56ea5a67.png


2. 字体效果

推荐星号(*),若安装了markdownlint插件,你的全文的加粗/斜体的符号要统一,不然就会提醒你,但无关紧要,所以说这是一个可选的插件,但最好养成习惯统一符号。

1
2
3
4
5
6
**这是加粗**
__这也是加粗__

*这是斜体*
_这也是斜体_
~~这是删除线~~

效果:
5eda7b70-5e03-46a8-9dc7-eebdeef17ee5.png


3. 列表

用一个 -*+ 来表示一个无序列表,推荐用 - 。用一个 1. 表示一个有序列表,都必须跟一个空格。

其中全部的有序列表都可以全部用 1. 来表示,会自动排序,不用写2. 3. 。推荐这种方法。

效果:
ee57943e-fb4d-4fdb-83fe-78d37451cb9f.png


4. 链接

1
2
3
4
5
6
7
![图片的名称,可以为空](网址)  # 这是图片的引用方式
[中括号里是对外显示的字体,点击字体即可跳转](网址) # 这是网址的引用方式
右边是一个可点击的网址:<网址> # 这是外显网址的网址引用方式

![这里可以为空,只有当图片的连接被删除无法正常显示时才会显示中括号里面的文字](https://img.999314.xyz/file/1778336372366_file_00000000d7947209a2d157c4778d9136.png)
[点这里去到百度](https://www.baidu.com)
右边是一个可点击的网址:<https://www.baidu.com>

效果:
image.png


5. 引用块

1
2
3
> 这是一个段落引用,以>打头,接一个空格,后面接内容,常用于引用别人的话或者一些警告。

`这是行内代码引用,在两个反引号(Tab键上面)之间的字符会有虚影效果,常用于代码标记`

效果:
41dc3440-864f-41f6-bd64-8325fdfd888c.png

两对三反引号之间包裹代码块,可以在首个三反引号后面指定语言,比如py、java、bash、md等等,例如下面的例子。
63a12e1d-cb0a-4601-99bc-f4fa958287b9.png

效果:
244b0c77-6ece-47a4-b07f-6c1562d882aa.png

这也就是为什么AI生成的代码块左上角会标注有类似于“bash”、“python”、“c”等的原因。


6. 表格

1
2
3
4
5
6
7
8
9
10
11
12
13
14
基本格式是:
| 表头 | 表头 |
| --- | --- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |

两边的 `|` 可以不写,单元格和表头之间必须用至少三个 `---` 来隔开。
打上冒号还能实现对齐方式,默认是左对齐。

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

效果:
b4e973a4-4240-4afe-8aaf-13907c299dfd.png

7. 其他

  1. 分割线
    以至少三个及以上的-+* 来表示,推荐 - ,若安装了 markdownlint插件,她会要求你分割线上下要空格一行,不然会用黄色波浪线提醒你。
    效果:
    d85f9bed-fb9f-477f-aea6-6f116e2f770d.png

大部分的md渲染器都能支持HTML和CSS的部分语法,例如:

  1. kbd 标签
    能表示键盘上的按键,类似于一对反引号的效果。
    比如打开任务管理器的快捷键是Ctrl+Shift+Esc,则可以用kbd标签来表示:
1
<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Esc</kbd>

效果:
1e5b5f64-e58c-40a6-add1-afd7bfa3eaf0.png

当然会有很多的语法,但上面这些已经能满足90%的场景,其余的诸如数学公式、甘特图、流程图的表示等,需要用到再去菜鸟教程看看就行了。

参考&致谢

菜鸟教程:https://www.runoob.com/markdown/md-tutorial.html