4
4
5
5
[@Paulkm2006](https://github.com/Paulkm2006)
6
6
7
- Markdown 是一种轻量级标记语言,常用于编写文档、说明和博客。在开源软件的贡献中,我们常常使用 Markdown 来编写文档、需求与说明等。
8
-
9
- 同时,Github 等代码分享平台默认均以 Markdown 语法渲染文档:我们常常在项目仓库中见到的` README.md ` 、` CONTRIBUTING.md ` 等文件均是 Markdown 编写的;在提出 Issue、描述 Pull Request 时,我们同样使用 Markdown 编写对应的消息。
7
+ Markdown 是一种轻量级标记语言,具有** 语法简洁、易读易写** 的特点,广泛应用于文档编写、笔记记录和博客撰写等场景。GitHub、Gitee 等代码托管平台默认支持 Markdown 渲染,项目仓库中的 ` README.md ` 、` CONTRIBUTING.md ` 文件,以及 Issue 和 Pull Request 的描述信息,均采用 Markdown 语法。
10
8
11
9
## 1. 标题
12
10
13
- 使用` # ` 表示标题,数量表示级别(1 ~ 6 级)。养成良好的标题习惯可以让他人方便地找到想要的资料 。
11
+ 使用 ` # ` 表示标题,` # ` 的数量决定标题级别(从 1 级到 6 级)。合理设置标题层级,有助于提升文档结构清晰度,方便他人快速查找所需 。
14
12
15
13
``` markdown
16
14
# 一级标题
17
15
## 二级标题
18
16
### 三级标题
17
+ #### 四级标题
18
+ ##### 五级标题
19
+ ###### 六级标题
19
20
```
20
21
21
22
## 2. 段落与换行
22
23
23
- 直接输入文本即为段落。段落之间空一行。
24
+ 直接输入文本即为一个段落,段落之间需空一行。例如:
25
+
26
+ ``` markdown
27
+ 这是第一段。
28
+
29
+ 这是第二段。
30
+ ```
31
+
32
+ 如需在同一段落内换行,可在行末添加两个空格后回车:
33
+
34
+ ``` markdown
35
+ 这是第一行。(注意当前行最后有两个空格)
36
+ 这是第二行。
37
+ ```
24
38
25
39
## 3. 强调
26
40
@@ -30,7 +44,7 @@ Markdown 是一种轻量级标记语言,常用于编写文档、说明和博
30
44
31
45
## 4. 列表
32
46
33
- - 无序列表:使用` - ` 、` * ` 或 ` + `
47
+ - 无序列表:使用 ` - ` 、` * ` 或 ` + `
34
48
- 有序列表:使用数字加点
35
49
36
50
``` markdown
@@ -57,30 +71,39 @@ Markdown 是一种轻量级标记语言,常用于编写文档、说明和博
57
71
58
72
在插入图片时,我们必须保证该链接**可以被外界访问**,这意味着你的图片必须满足以下条件之一
59
73
60
- 1. 图片必须作为附件随 markdown 文件上传 ,且路径为相对路径(如`assets/img.jpg`)
61
- 2. 图片上传到了互联网可访问的托管服务
74
+ 1. 图片必须作为附件随 markdown 文件上传到当前仓库 ,且路径为相对路径(如 `assets/img.jpg`)
75
+ 2. 图片已上传到互联网可访问的托管服务
62
76
63
- 有关插入图片的更多用法,请参考第二节
77
+ 有关插入图片的更多用法,请参考本章第二节 - Markdown 进阶语法。
64
78
65
79
## 6. 引用
66
80
67
- 使用` > ` 表示引用。
81
+ 使用 ` > ` 表示引用。
68
82
69
83
``` markdown
70
84
> 这是一个引用
71
85
```
72
86
73
- > Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
74
-
75
87
## 7. 代码
76
88
77
- - 行内代码:用反引号包裹,如 `` `代码` ``
78
- - 代码块:用三个反引号包裹。通常来说,Markdown 编辑器能自动识别代码语言并高亮;但当遇到识别错误时,我们可以使用` ```<语言名称> ` 来告诉编辑器。
89
+ 代码块常用于展示示例代码、命令行操作或配置文件内容,便于理解与复制。
90
+
91
+ - 行内代码:用反引号包裹,如 `` `print()` ``
92
+ - 代码块:用三个反引号包裹。通常来说,Markdown 编辑器能自动识别代码语言并高亮;但当遇到识别错误时,我们可以使用 ` ```<语言名称> ` 来告诉编辑器。
79
93
80
94
``` python
81
95
print (" Hello, Markdown!" )
82
96
```
83
97
98
+ ``` c
99
+ #include < stdio.h>
100
+ int main ()
101
+ {
102
+ printf ("Hello, Markdown!");
103
+ return 0;
104
+ }
105
+ ```
106
+
84
107
## 8. 表格
85
108
86
109
``` markdown
@@ -104,11 +127,11 @@ print("Hello, Markdown!")
104
127
105
128
!!! tips
106
129
107
- 通常来说,手工实现的 markdown 表格在源文件中不甚美观。因此,我们可以使用[Markdown 表格生成器](https://www.tablesgenerator.com/markdown_tables)来生成一个表格
130
+ 通常来说,手工实现的 markdown 表格在源文件中不甚美观。因此,我们可以使用 [Markdown 表格生成器](https://www.tablesgenerator.com/markdown_tables)来生成一个表格。
108
131
109
132
## 9. 分割线
110
133
111
- 使用三个及以上的` - ` 、` * ` 或 ` _ `
134
+ 使用三个及以上的 ` - ` 、` * ` 或 ` _ ` 可表示分割线。
112
135
113
136
``` markdown
114
137
---
@@ -151,4 +174,4 @@ print("Hello, Markdown!")
151
174
152
175
---
153
176
154
- 以上是 Markdown 的常用基础语法,更多高级用法可参考[ Markdown 官方文档] ( https://markdown.com.cn/basic-syntax/ ) 。
177
+ 以上是 Markdown 的常用基础语法,更多高级用法可参考 [ Markdown 官方文档] ( https://markdown.com.cn/basic-syntax/ ) 。
0 commit comments