Skip to content

Commit 21035d1

Browse files
committed
docs(handbook): 添加关于Markdown任务列表的说明
在Markdown文档中新增任务列表的语法说明和使用示例,完善列表功能文档
1 parent 82a8a4d commit 21035d1

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/rules/academic/handbook/markdown.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ Markdown 标记区块引用的方法是在行的最前面加 `>`,也可以只
256256
257257
## 列表
258258
259-
Markdown 支持有序列表和无序列表,无序列表使用星号、加号或是减号作为列表标记,有序列表则使用数字接着一个英文句点。两种列表方式格式都是:列表标记 + 空格 + 列表项,即列表项目标记通常是放在最左边,也可以缩进最多 $3$ 个空格,项目标记后面则一定要接着至少一个空格或制表符。
259+
Markdown 支持有序列表和无序列表以及任务列表。无序列表使用星号、加号或是减号作为列表标记,有序列表则使用数字接着一个英文句点。两种列表方式格式都是:列表标记 + 空格 + 列表项,即列表项目标记通常是放在最左边,也可以缩进最多 $3$ 个空格,项目标记后面则一定要接着至少一个空格或制表符。
260260
261261
### 1 无序列表
262262
@@ -302,6 +302,24 @@ Markdown 支持有序列表和无序列表,无序列表使用星号、加号
302302
2. Green
303303
3. Blue
304304

305+
### 3 任务列表
306+
307+
任务列表是一种特殊的列表,它可以在列表项前添加复选框,用于表示任务是否完成。任务列表的格式为:`- [ ] 任务项``- [x] 任务项`,其中 `[ ]` 表示未完成任务,`[x]` 表示已完成任务。
308+
309+
**例如:**
310+
311+
```markdown
312+
- [ ] 学习 Markdown 语法
313+
- [x] 完成 Markdown 语法学习
314+
- [ ] 编写 Markdown 文档
315+
```
316+
317+
显示效果为:
318+
319+
- [ ] 学习 Markdown 语法
320+
- [x] 完成 Markdown 语法学习
321+
- [ ] 编写 Markdown 文档
322+
305323
## 链接
306324

307325
在方块括号后面紧接着圆括号并插入网址链接即可,如果还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:

0 commit comments

Comments
 (0)