Skip to content

从零开始学习 markdown

VitePress的技术文档使用markdown(.md)格式。md格式被广泛的引用于各类文档,好处包括:不用想文章格式,交给渲染器渲染;比较沉浸的写作体验等。新手刚开始写markdown,不用记太多的语法,自己用到什么就查一下。

基础语法用的比较熟练了,可以看看菜鸟教程的markdown系统教学VitePress的官方文档里的markdown语法介绍再系统学习一下。

1. 基本语法

  1. 标题,标题用#表示,每多一个层级就多一个#,最多支持六个层级,像论文一般最多三级标题。
md
# 一级标题
## 二级标题
### 三级标题

DANGER

像我一样的纯纯新手,要注意#后面有一个空格,不然md的渲染器不会识别它是一个标题。

  1. markdown 里换行使用两个空格+回车,或者直接回车换行两次(即两个段落间空一行)。

2. 字体样式

  1. 粗体语法:使用两个星号 ** 包围文字
  2. 斜体语法:使用一个星号 * 包围文字
  3. 删除线语法:使用两个波浪线 ~~ 包围文字

3. 插入链接

  1. 插入网页链接
md
[链接文字](https://www.runoob.com/markdown/md-tutorial.html)
  1. 插入图片
md
![图片文字](/red-book.svg) //图片路径从public文件夹开始,用前面的/表示public文件夹

4. 代码引用

文字中的行内代码引用使用一个反引号 ` 包围文字,例如print("Hello World")

md
这是一段行内代码:`print("Hello World")`

代码块引用使用三个反引号 ``` 包围代码,语言类型可以写在反引号后面用来高亮。

输入

md
``` python
famous_person = "a"
message = f'{famous_person} once said "A person who never made a mistake never tried anything new."'
print(message)
```

渲染结果

python
famous_person = "a"
message = f'{famous_person} once said "A person who never made a mistake never tried anything new."'
print(message)

5. 列表

  1. 有序列表使用数字加点加空格。
  2. 无序列表使用星号加空格。

输入

md
1. 有序列表
2. 有序列表
3. 有序列表

* 无序列表
* 无序列表
* 无序列表

渲染结果

  1. 有序列表
  2. 有序列表
  3. 有序列表
  • 无序列表
  • 无序列表
  • 无序列表
  1. Github风格表格

输入

md
| 姓名 | 年龄 | 性别 |
|:------|:------:|------:| // :左对齐,:中间对齐,:右对齐
| 张三 | 25 | 男 |
| 李四 | 26 | 女 |

渲染结果

姓名年龄性别
张三25
李四26

6. 引用

引用,用>表示

渲染结果

这是一个引用

7. VitePress 特有的语法

  1. 容器

输入

md
::: info  //这里后面可以跟文字,自定义容器标题
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::

渲染结果

INFO

This is an info box.

TIP

This is a tip.

WARNING

This is a warning.

DANGER

This is a dangerous warning.

Details

This is a details block.

  1. 徽标

输入

md
### Title <Badge type="info" text="default" />
### Title <Badge type="tip" text="^1.9.0" />
### Title <Badge type="warning" text="beta" />
### Title <Badge type="danger" text="caution" />

渲染结果

Title default

Title ^1.9.0

Title beta

Title caution

Released under the MIT License.