Skip to content

Commit e2f7800

Browse files
ywh555hhhPlucky923
authored andcommitted
feat: Add Git training content, Markdown extensions, and platform overview with basic operations.
feat: Create initial file structure feat: Add multiple Markdown extensions to enhance documentation feat: Add platform overview and basic operations guide feat: 添加Git训练营章节及相关内容 创建文件 feat: 添加多个Markdown扩展以增强文档功能 feat: 添加代码托管平台简介及基本操作指南
1 parent 4fae5a1 commit e2f7800

File tree

10 files changed

+131
-0
lines changed

10 files changed

+131
-0
lines changed

docs/ch5/index.md

Whitespace-only changes.

docs/ch5/sec1/git-guidance.md

Whitespace-only changes.

docs/ch5/sec1/subsec1/git-introduction.md

Whitespace-only changes.
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# 代码托管平台简介
2+
3+
> 本课程旨在让学生了解如何使用代码托管平台(如 GitHub、Gitee 等)进行代码管理与协作,掌握平台的基本功能和常用操作。
4+
5+
---
6+
7+
## 常用代码托管平台
8+
9+
以下是常见的代码托管平台及其特点:
10+
11+
=== "GitHub"
12+
- **简介**: 全球最大的代码托管平台,支持 Git 版本控制。
13+
- **功能**:
14+
- 代码托管
15+
- 问题跟踪(Issues)
16+
- 拉取请求(Pull Requests)
17+
- 代码审查
18+
- 项目管理
19+
- **适用场景**: 开源项目、团队协作。
20+
21+
=== "Gitee"
22+
- **简介**: 中国本土的代码托管平台,功能与 GitHub 类似。
23+
- **功能**:
24+
- 代码托管
25+
- 问题跟踪
26+
- 拉取请求
27+
- 代码审查
28+
- 项目管理
29+
- **适用场景**: 国内开发者、访问速度较快。
30+
31+
=== "AtomGit"
32+
- **简介**: 新兴的代码托管平台,提供类似 GitHub 和 Gitee 的功能。
33+
- **功能**:
34+
- 代码托管
35+
- 问题跟踪
36+
- 拉取请求
37+
- 代码审查
38+
- 项目管理
39+
- **适用场景**: 尝试新平台的开发者。
40+
41+
---
42+
43+
## 平台基本功能与操作
44+
45+
### 浏览与搜索仓库
46+
47+
??? note "浏览仓库"
48+
- **操作步骤**:
49+
1. 打开平台(如 GitHub 或 Gitee)的网站。
50+
2. 在首页或搜索栏中输入关键词,查找感兴趣的仓库。
51+
3. 点击仓库名称进入仓库详情页面,查看代码、问题、拉取请求等内容。
52+
53+
??? tip "搜索仓库"
54+
- **操作步骤**:
55+
1. 在搜索栏中输入关键词(如项目名称、编程语言等)。
56+
2. 使用过滤器(如语言、星标数、更新时间等)缩小搜索范围。
57+
3. 点击搜索结果中的仓库名称进入详情页面。
58+
59+
### 主要操作
60+
61+
#### **Fork**
62+
!!! info "功能描述"
63+
将别人的仓库复制到自己的账户下,便于修改和贡献。
64+
65+
- **操作步骤**:
66+
1. 进入目标仓库页面。
67+
2. 点击页面右上角的“Fork”按钮。
68+
3. 等待 Fork 完成,仓库将出现在自己的账户下。
69+
70+
#### **Star**
71+
!!! success "功能描述"
72+
对仓库点赞,表示对项目的支持和喜爱。
73+
74+
- **操作步骤**:
75+
1. 进入目标仓库页面。
76+
2. 点击页面右上角的“Star”按钮。
77+
3. 取消 Star 只需再次点击“Star”按钮。
78+
79+
#### **Watch**
80+
!!! warning "功能描述"
81+
关注仓库,接收仓库的更新通知。
82+
83+
- **操作步骤**:
84+
1. 进入目标仓库页面。
85+
2. 点击页面右上角的“Watch”按钮。
86+
3. 选择接收通知的频率(如所有活动、仅发布和评论等)。
87+
4. 取消 Watch 只需再次点击“Watch”按钮并选择“Not watching”。
88+
89+
---
90+
91+
## 总结
92+
93+
!!! summary "学习目标"
94+
- 了解常见的代码托管平台(如 GitHub、Gitee 等)及其基本功能。
95+
- 学会在浏览器中浏览和搜索仓库。
96+
- 掌握平台的主要操作,如 Fork、Star、Watch 等。
97+
98+
这些技能将为后续的代码开发、团队协作和开源贡献打下坚实的基础。

docs/ch5/sec1/subsec3/practice.md

Whitespace-only changes.

docs/ch5/sec1/subsec4/create-repo.md

Whitespace-only changes.

docs/ch5/sec2/git-basics.md

Whitespace-only changes.

docs/ch5/sec3/git-advanced.md

Whitespace-only changes.

docs/ch5/sec4/git-projects.md

Whitespace-only changes.

mkdocs.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,28 @@ theme:
4343
markdown_extensions:
4444
- admonition
4545
- footnotes
46+
- markdown.extensions.def_list
47+
- md_in_html
48+
- pymdownx.details
49+
- pymdownx.tabbed
50+
- pymdownx.emoji:
51+
emoji_index: !!python/name:material.extensions.emoji.twemoji
52+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
53+
- pymdownx.highlight:
54+
anchor_linenums: true
55+
- pymdownx.inlinehilite
56+
- pymdownx.snippets:
57+
auto_append:
58+
- includes/man.md
59+
- includes/authors.md
60+
- pymdownx.superfences:
61+
custom_fences:
62+
- name: mermaid
63+
class: mermaid
64+
format: !!python/name:pymdownx.superfences.fence_code_format
65+
- toc:
66+
permalink: true
67+
4668

4769
extra:
4870
social:
@@ -71,5 +93,16 @@ nav:
7193
- 四、领导开源:
7294
- 第四章 导览: ch4/index.md
7395

96+
- 五、Git 训练营:
97+
- 第五章导览: ch5/index.md
98+
- 导学阶段:
99+
- Git 简介: ch5/sec1/subsec1/git-introduction.md
100+
- 代码托管平台简介: ch5/sec1/subsec2/code-hosting-platforms.md
101+
- 实践:注册并熟悉代码托管平台: ch5/sec1/subsec3/practice.md
102+
- 创建并管理仓库 (Repository): ch5/sec1/subsec4/create-repo.md
103+
- 基础阶段: ch5/sec2/git-basics.md
104+
- 专业阶段: ch5/sec3/git-advanced.md
105+
- 项目阶段: ch5/sec4/git-projects.md
106+
74107
- 附录:
75108
- 关于本教程: ch99/abouts.md

0 commit comments

Comments
 (0)