从其它平台迁移而来

基础知识

  • 后缀名一般为.md

  • 只关注于内容，渲染交给页面或软件来实现

语法

标题

1
2
3
4
5
6

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

段落

连续两个回车或连续两个空格一个回车表示一个段落的结束。

有序列表

1
2
3
4
5

1. 有序列表1

2. 有序列表2

3. 有序列表3

无序列表

1
2
3
4
5

- 无序列表1

- 无序列表2

- 无序列表3

任务列表

1
2
3

- [ ] 这是未完成

- [x] 这是已完成
  • 这是扩展语法，部分渲染可能不支持。

引用

1
2
3

> 这是引用的内容
>
> 这是又一行的引用内容

格式

1
2
3

*这是斜体*
**这是加粗**
~~这是删除线~~

分隔线

1
2
3

---
***
___

代码块

1

`这是行内代码块`

1
2
3

```
这是多行代码块
```

1
2
3
4
5
6
7

```c
//在```之后加语言名可进行语法高亮，具体看渲染如何实现
# include <stdio.h>
int main(){
  return 0;
}
```

表格

1
2
3

|列标题1|列标题2|列标题3|
|-------|-------|-------|
|列内容1|列内容2|列内容3|

  • 两端的|可以省略

  • 中间连续的---可以只用一个-

  • 单独的-或:-表示左对齐

  • -:表示右对齐

  • :-:表示居中

超链接

1

[超链接显示名称](超链接地址 "超链接提示")

图片

1

![图片显示名称](图片地址 "图片提示")

脚注

1
2
3
4
5

这是文档内容，加个脚注[^1]看看。

[^1]: 这是脚注内容，不一定非要写到文章末尾。

这里是接着的内容。
  • 这是扩展语法，部分渲染可能不支持。

其它

  • 部分语法之间可以进行互相嵌套。

  • 可以嵌套html标签，但个人不建议使用，除非有必要且Markdown不支持。

  • 多行代码块也可以使用Mermaid语法来表示流程图、饼图、甘特图等，但需要渲染支持。

详情请看官方教程。