编辑器

推荐使用 vscode

标题

使用 # 号标记
使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。

语法

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

效果

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

换行

两个空格换行

字体

*斜体文本*
**粗体文本**
***粗斜体文本***
~~删除线~~

效果

斜体文本
粗体文本
粗斜体文本
删除线

分割线

语法

***

效果


列表

无序列表

语法

* 第一项
* 第二项
* 第三项

效果

  • 第一项
  • 第二项
  • 第三项

有序列表

语法

1. 第一项
2. 第二项
3. 第三项

效果

  1. 第一项
  2. 第二项
  3. 第三项

列表嵌套

语法

子列表中的选项添加四个空格即可

效果

  1. 第一项:
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项:
    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

区块

语法

> 这是一个区块
>> 这里一个嵌套的区块

效果

这是一个区块

这里一个嵌套的区块

代码块

代码片段

语法

`printf` 函数

效果

printf 函数

代码区块

语法

```c++
void main() {
printf(“hello world”)
}
```

```lua
function test()

end
```

效果

void main() {
printf("hello world")
}
function test() 

end

链接

语法

请访问[github](http://www.github.com\)

效果

请访问github

图片

语法

![替代文字](../logo.png)

效果

替代文字

表格

语法

表一

| 表头 | 表头 |
| -— | -— |
| 大单元格 | 大单元格 |
| 单元格 | 单元格 |

表二

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

效果

表一

表头 表头
大单元格 大单元格
单元格 单元格

表二

左对齐 右对齐 居中对齐
大单元格 大单元格 大单元格
单元格 单元格 单元格