Skip to content

Commit c6011ad

Browse files
committed
fix spaces in mkdocs and index.md; revise some statements in markdown basics
1 parent 8ce1f56 commit c6011ad

File tree

3 files changed

+80
-45
lines changed

3 files changed

+80
-45
lines changed

docs/ch3/index.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@
33
!!! note "主要作者"
44
[@Dreadful_Me](https://github.com/Dreadful_Me)
55

6-
## 🚀 开启 Git 与协作之旅
6+
## 🚀 开启 Git 与协作之旅
7+
78
本章将带您系统掌握开源贡献全流程技能,从 Git 基础到高级协作,从个人项目管理到社区级贡献,通过渐进式学习路径成长为合格的开源贡献者。
89

9-
## markdown 基础
10+
## Markdown 基础技能
11+
1012
!!! note 基本语法
1113
在这里,你将学习:
1214

@@ -26,7 +28,6 @@
2628

2729
8. 最后,利用**分割线**让不同的段落泾渭分明
2830

29-
3031
!!! warning 进阶语法
3132
除了基本的对文本的操作,markdown 文档能做的不止于此:
3233

@@ -41,13 +42,16 @@
4142
- ......
4243

4344
## 💡 四阶段学习体系
45+
4446
### 1. [导学阶段](https://oss.hust.openatom.club/ch3/sec1/subsec1/1-git-introduction/)
47+
4548
!!! tip "环境准备三步走"
4649
1. **平台初识**:GitHub/Gitee 功能探索
4750
2. **实战入门**:创建首个仓库
4851
3. **合规起点**:选择开源许可证
4952

5053
!!! example "核心任务卡"
54+
5155
```mermaid
5256
graph TB
5357
A[注册GitHub] --> B[创建个人仓库]
@@ -57,41 +61,45 @@
5761
```
5862

5963
### 2. [基础阶段](https://oss.hust.openatom.club/ch3/sec1/subsec2/1-basic-configuration/)
64+
6065
!!! warning "Git 生存法则"
6166
| 场景 | 核心命令 | 应用要点 |
6267
|------|----------|----------|
6368
| 版本控制 | `git init/clone` | 建立版本库 |
64-
| 变更管理 | `git add/commit` | 原子性提交 |
65-
| 问题排查 | `git diff/reset` | 撤销与比对 |
69+
| 变更管理 | `git add/commit` | 原子性提交 |
70+
| 问题排查 | `git diff/reset` | 撤销与比对 |
6671

6772
### 3. [专业阶段](https://oss.hust.openatom.club/ch3/sec1/subsec3/1-rebase-merge/)
73+
6874
!!! tip "高级工作流"
69-
```mermaid
70-
graph LR
71-
A[特性分支] --> B{合并策略}
72-
B -->|协作开发| C[Rebase]
73-
B -->|公共分支| D[Merge]
74-
C --> E[整洁历史]
75+
```mermaid
76+
graph LR
77+
A[特性分支] --> B{合并策略}
78+
B -->|协作开发| C[Rebase]
79+
B -->|公共分支| D[Merge]
80+
C --> E[整洁历史]
7581
D --> F[保留轨迹]
7682
```
7783

7884
### 4. [项目阶段](https://oss.hust.openatom.club/ch3/sec1/subsec4/1-linux-patch/)
85+
7986
!!! danger "Linux 内核贡献须知"
8087
- 遵循内核编码规范
8188
- 补丁包含完整变更说明
8289
- 通过邮件列表提交
8390

8491
!!! success "团队协作评估"
85-
```mermaid
92+
```mermaid
8693
pie
87-
title 贡献评估维度
94+
title 贡献评估维度
8895
"代码质量" : 40
8996
"文档完善" : 25
9097
"Issue解决" : 20
9198
"社区互动" : 15
9299
```
93100

94101
## 🔧 开发工具箱
102+
95103
| 类别 | 推荐工具 | 应用场景 |
96104
|------------|-------------------------|-----------------------|
97105
| **版本控制** | Git + GitLens | 代码历史管理 |
@@ -100,6 +108,7 @@
100108
| **调试分析** | GitHub Network Graph | 项目关系可视化 |
101109

102110
## 🌟 拓展技能树
111+
103112
```mermaid
104113
graph TD
105114
A[开源贡献技能] --> B[Linux训练营]
@@ -112,9 +121,12 @@ graph TD
112121
D --> I[Markdown精通]
113122
D --> J[文档工程]
114123
```
124+
115125
## 🔧明星工具推荐
126+
116127
!!! example "效率提升神器"
128+
117129
- tmux:终端会话管理(多窗口操作)
118130
- better-commits:规范化提交助手
119131
- opencommit:AI 生成提交信息
120-
- pre-commit:自动化代码检查
132+
- pre-commit:自动化代码检

docs/ch3/sec0/1-basic.md

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,37 @@
44

55
[@Paulkm2006](https://github.com/Paulkm2006)
66

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 语法。
108

119
## 1. 标题
1210

13-
使用`#`表示标题,数量表示级别(1~6 级)。养成良好的标题习惯可以让他人方便地找到想要的资料
11+
使用 `#` 表示标题,`#` 的数量决定标题级别(从 1 级到 6 级)。合理设置标题层级,有助于提升文档结构清晰度,方便他人快速查找所需
1412

1513
```markdown
1614
# 一级标题
1715
## 二级标题
1816
### 三级标题
17+
#### 四级标题
18+
##### 五级标题
19+
###### 六级标题
1920
```
2021

2122
## 2. 段落与换行
2223

23-
直接输入文本即为段落。段落之间空一行。
24+
直接输入文本即为一个段落,段落之间需空一行。例如:
25+
26+
```markdown
27+
这是第一段。
28+
29+
这是第二段。
30+
```
31+
32+
如需在同一段落内换行,可在行末添加两个空格后回车:
33+
34+
```markdown
35+
这是第一行。(注意当前行最后有两个空格)
36+
这是第二行。
37+
```
2438

2539
## 3. 强调
2640

@@ -30,7 +44,7 @@ Markdown 是一种轻量级标记语言,常用于编写文档、说明和博
3044

3145
## 4. 列表
3246

33-
- 无序列表:使用`-``*``+`
47+
- 无序列表:使用 `-``*``+`
3448
- 有序列表:使用数字加点
3549

3650
```markdown
@@ -57,30 +71,39 @@ Markdown 是一种轻量级标记语言,常用于编写文档、说明和博
5771

5872
在插入图片时,我们必须保证该链接**可以被外界访问**,这意味着你的图片必须满足以下条件之一
5973

60-
1. 图片必须作为附件随 markdown 文件上传,且路径为相对路径(如`assets/img.jpg`)
61-
2. 图片上传到了互联网可访问的托管服务
74+
1. 图片必须作为附件随 markdown 文件上传到当前仓库,且路径为相对路径(如 `assets/img.jpg`)
75+
2. 图片已上传到互联网可访问的托管服务
6276

63-
有关插入图片的更多用法,请参考第二节
77+
有关插入图片的更多用法,请参考本章第二节 - Markdown 进阶语法。
6478

6579
## 6. 引用
6680

67-
使用`>`表示引用。
81+
使用 `>` 表示引用。
6882

6983
```markdown
7084
> 这是一个引用
7185
```
7286

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-
7587
## 7. 代码
7688

77-
- 行内代码:用反引号包裹,如 `` `代码` ``
78-
- 代码块:用三个反引号包裹。通常来说,Markdown 编辑器能自动识别代码语言并高亮;但当遇到识别错误时,我们可以使用` ```<语言名称> `来告诉编辑器。
89+
代码块常用于展示示例代码、命令行操作或配置文件内容,便于理解与复制。
90+
91+
- 行内代码:用反引号包裹,如 `` `print()` ``
92+
- 代码块:用三个反引号包裹。通常来说,Markdown 编辑器能自动识别代码语言并高亮;但当遇到识别错误时,我们可以使用 ` ```<语言名称> ` 来告诉编辑器。
7993

8094
```python
8195
print("Hello, Markdown!")
8296
```
8397

98+
```c
99+
#include <stdio.h>
100+
int main()
101+
{
102+
printf("Hello, Markdown!");
103+
return 0;
104+
}
105+
```
106+
84107
## 8. 表格
85108

86109
```markdown
@@ -104,11 +127,11 @@ print("Hello, Markdown!")
104127

105128
!!! tips
106129

107-
通常来说,手工实现的 markdown 表格在源文件中不甚美观。因此,我们可以使用[Markdown 表格生成器](https://www.tablesgenerator.com/markdown_tables)来生成一个表格
130+
通常来说,手工实现的 markdown 表格在源文件中不甚美观。因此,我们可以使用 [Markdown 表格生成器](https://www.tablesgenerator.com/markdown_tables)来生成一个表格
108131

109132
## 9. 分割线
110133

111-
使用三个及以上的`-``*``_`
134+
使用三个及以上的 `-``*``_` 可表示分割线。
112135

113136
```markdown
114137
---
@@ -151,4 +174,4 @@ print("Hello, Markdown!")
151174

152175
---
153176

154-
以上是 Markdown 的常用基础语法,更多高级用法可参考[Markdown 官方文档](https://markdown.com.cn/basic-syntax/)
177+
以上是 Markdown 的常用基础语法,更多高级用法可参考 [Markdown 官方文档](https://markdown.com.cn/basic-syntax/)

mkdocs.yml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -99,37 +99,37 @@ nav:
9999
- 开源项目的法律与合规: ch2/sec3/3-legal-and-compliance.md
100100
- 三、开源贡献基础技能:
101101
- 导览: ch3/index.md
102-
- 第零节 Markdown基础:
103-
- Markdown基本语法: ch3/sec0/1-basic.md
104-
- Markdown进阶用法: ch3/sec0/2-advanced.md
105-
- 第一节 Git训练营:
102+
- 第零节 Markdown 基础:
103+
- Markdown 基本语法: ch3/sec0/1-basic.md
104+
- Markdown 进阶用法: ch3/sec0/2-advanced.md
105+
- 第一节 Git 训练营:
106106
- 导学阶段:
107-
- Git简介: ch3/sec1/subsec1/1-git-introduction.md
107+
- Git 简介: ch3/sec1/subsec1/1-git-introduction.md
108108
- 代码托管平台简介: ch3/sec1/subsec1/2-code-hosting-platforms.md
109109
- 注册并熟悉代码托管平台: ch3/sec1/subsec1/3-practice-code-hosting-platforms.md
110110
- 创建并管理仓库: ch3/sec1/subsec1/4-create-repo.md
111111
- 开源许可证选择指南: ch3/sec1/subsec1/5-open_source_License.md
112112
- GitHub Fork 简明解析: ch3/sec1/subsec1/6-fork.md
113113
- 基础阶段:
114-
- Git的基础配置: ch3/sec1/subsec2/1-basic-configuration.md
114+
- Git 基础配置: ch3/sec1/subsec2/1-basic-configuration.md
115115
- 暂存区操作: ch3/sec1/subsec2/2-staging.md
116116
- 暂存区操作(续): ch3/sec1/subsec2/3-reset-diff-and-commit.md
117-
- 如何写好一个commit message: ch3/sec1/subsec2/6-commit-message.md
117+
- 如何写好一个 commit message: ch3/sec1/subsec2/6-commit-message.md
118118
- 专业阶段:
119-
- Git Rebase与Git Merge的使用与区别: ch3/sec1/subsec3/1-rebase-merge.md
119+
- Git Rebase 与 Git Merge 的使用与区别: ch3/sec1/subsec3/1-rebase-merge.md
120120
- Git 分布式版本控制工作原理: ch3/sec1/subsec3/2-Control-Process.md
121-
- Git辅助本地项目开发: ch3/sec1/subsec3/3-help-open.md
122-
- Git的进阶理论: ch3/sec1/subsec3/5-advanced-theory.md
121+
- Git 辅助本地项目开发: ch3/sec1/subsec3/3-help-open.md
122+
- Git 进阶理论: ch3/sec1/subsec3/5-advanced-theory.md
123123
- 参与开源项目: ch3/sec1/subsec3/7-participate-in.md
124124
- 项目阶段:
125-
- 贡献一个Linux patch: ch3/sec1/subsec4/1-linux-patch.md
125+
- 贡献一个 Linux patch: ch3/sec1/subsec4/1-linux-patch.md
126126
- 团队项目合作: ch3/sec1/subsec4/2-teamwork.md
127-
- 第二节 Linux训练营:
127+
- 第二节 Linux 训练营:
128128
- 其他命令与工具: ch3/sec2/4-other-commands.md
129-
- 第三节 docker训练营:
129+
- 第三节 Docker 训练营:
130130
- Docker 基础: ch3/sec3/1_foundation.md
131131
- 自定义镜像之 Dockerfile 详解: ch3/sec3/2_dockerfile.md
132-
- 第四节 QEMU训练营:
132+
- 第四节 QEMU 训练营:
133133
- 参与 QEMU 邮件列表讨论: ch3/sec4/1-qemu-send-email.md
134134
- 第五节 杂项:
135135
- 常用的开源工具: ch3/sec5/1-useful-oss.md

0 commit comments

Comments
 (0)