Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit d0622bb

Browse files
committed
docs: edit title
1 parent d055ae6 commit d0622bb

File tree

1 file changed

+70
-4
lines changed

1 file changed

+70
-4
lines changed

docs/title.md

+70-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,76 @@
99
- 三级标题:二级标题下面一级的小标题
1010
- 四级标题:三级标题下面某一方面的小标题
1111

12+
下面是示例。
13+
14+
```markdown
15+
# 一级标题
16+
17+
## 二级标题
18+
19+
### 三级标题
20+
21+
#### 四级标题
22+
```
23+
1224
## 原则
1325

14-
- 一级标题下,不能直接出现三级标题。
15-
- 标题要避免孤立编号(即同级标题只有一个)。
16-
- 下级标题不重复上一级标题的内容。
17-
- 谨慎使用四级标题,尽量避免出现,保持层级的简单和防止出现过于复杂的章节。如果三级标题下有并列性的内容,建议只使用项目列表(Item list)。
26+
(1)一级标题下,不能直接出现三级标题。
27+
28+
示例:下面的文章结构,缺少二级标题。
29+
30+
```markdown
31+
# 一级标题
32+
33+
### 三级标题
34+
```
35+
36+
(2)标题要避免孤立编号(即同级标题只有一个)。
37+
38+
示例:下面的文章结构,`二级标题 A`只包含一个三级标题,完全可以省略`三级标题 A`
39+
40+
```markdown
41+
## 二级标题 A
42+
43+
### 三级标题 A
44+
45+
## 二级标题 B
46+
```
47+
48+
(3)下级标题不重复上一级标题的内容。
49+
50+
示例:下面的文章结构,二级标题与下属的三级标题同名,建议避免。
51+
52+
```markdown
53+
## 概述
54+
55+
### 概述
56+
```
57+
58+
(4)谨慎使用四级标题,尽量避免出现,保持层级的简单,防止出现过于复杂的章节。
59+
60+
如果三级标题下有并列性的内容,建议只使用项目列表(Item list)。
61+
62+
示例:下面的结构二要好于结构一。后者适用的场景,主要是较长篇幅的内容。
63+
64+
```markdown
65+
结构一
66+
67+
### 三级标题
68+
69+
#### 四级标题 A
70+
71+
#### 四级标题 B
72+
73+
#### 四级标题 C
74+
75+
结构二
76+
77+
### 三级标题
78+
79+
(1)A
80+
81+
(2)B
1882

83+
(3)C
84+
```

0 commit comments

Comments
 (0)