Merge pull request #43 from lurenjia1213/main

docs:Add git basic configuration and staging area

Author: mudongliang

docs/ch3/sec1/subsec2/1-basic-configuration.md

@@ -0,0 +1,212 @@
+# Git 基础配置
+
+> 让学生掌握 Git 的基本配置与命令。
+
+---
+
+## 1。配置 Git
+
+在使用 Git 之前，首先需要进行一些基本的配置，包括设置用户名和邮箱。这些信息会与每次提交（Commit）关联，用于标识代码的贡献者。
+
+### 配置用户名和邮箱
+
+- **命令**：
+
+  ```bash
+  git config --global user.name "你的用户名"
+  git config --global user.email "你的邮箱"
+  ```
+
+- **作用**：
+  - `user.name`：设置提交代码时显示的作者名称。
+  - `user.email`：设置提交代码时显示的作者邮箱。
+  - `--global`：表示全局配置，适用于当前用户的所有仓库。如果只想为某个仓库单独配置，可以去掉 `--global` 参数。
+- **提示**
+  - 有些时候，你不想让自己的邮箱与这个 git 用户有关联，可以使用 GitHub 等平台提供的隐私邮箱
+  
+### 查看配置信息
+
+- **命令**：
+
+  ```bash
+  git config --list
+  ```
+
+- **作用**：查看当前 Git 的所有配置信息，包括用户名、邮箱等。
+
+### 查看帮助
+
+- **比如我想看看 merge 是个什么玩意**：
+
+  ```bash
+  git help merge 
+  git merge --help
+  man git-merge
+  ```
+
+---
+
+## 2。使用 SSH 连接远程仓库
+
+SSH（Secure Shell）是一种加密的网络协议，用于安全地访问远程服务器。通过 SSH 连接 Git 远程仓库，可以避免每次操作时输入用户名和密码，同时提高数据传输的安全性。
+
+### 生成 SSH 密钥
+
+1. **检查是否已有 SSH 密钥**：
+  
+    打开终端，输入以下命令：
+
+    ```bash
+    ls ~/.ssh/
+    ```
+
+    如果文件存在，说明已有 SSH 密钥，可以跳过生成步骤。
+
+2. **生成新的 SSH 密钥**：
+
+    如果不存在 SSH 密钥，可以使用以下命令生成：
+
+     ```bash
+     ssh-keygen -t ed25519 -C "你的邮箱"
+     ```
+
+    按提示选择保存路径和设置密码（可选）。
+
+    生成成功后，会在 `~/.ssh/` 目录下生成两个文件：
+
+    - `id_ed25519`：私钥，切勿泄露。
+
+    - `id_ed25519.pub`：公钥，用于添加到远程仓库。
+
+3. **添加到 ssh-agent**：
+
+     ```bash
+     eval "$(ssh-agent -s)"
+     ssh-add ~/.ssh/id_ed25519
+     ```
+
+### 添加 SSH 密钥到远程仓库
+
+1. **复制公钥**：
+
+    使用以下命令复制公钥内容：
+
+    ```bash
+     cat ~/.ssh/id_ed25519.pub
+    ```
+
+    复制输出的全部内容。
+
+2. **添加到 GitHub**：
+
+    登录 GitHub，进入 **Settings** -> **SSH and GPG keys**。
+
+    点击 **New SSH key**，将复制的公钥粘贴到 Key 字段中，设置标题并保存。
+
+### 测试 SSH 连接
+
+- 使用以下命令测试 SSH 连接是否成功：
+
+  ```bash
+  ssh -T [email protected]
+  ```
+
+  - 如果显示 `Hi 用户名! You've successfully authenticated ...`，说明 SSH 配置成功。
+
+### 使用 SSH 克隆仓库
+
+- 使用 SSH 地址克隆远程仓库：
+
+  ```bash
+  git clone [email protected]:用户名/仓库名.git
+  ```
+
+### 将现有仓库切换为 SSH 连接
+
+- 如果已经使用 HTTPS 克隆了仓库，可以通过以下命令切换为 SSH：
+
+  ```bash
+  git remote set-url origin [email protected]:用户名/仓库名.git
+  ```
+
+- 使用 `git remote -v` 查看远程仓库地址，确认是否切换成功。
+
+- 如果你的网络环境比较特殊，可以修改 ssh 配置 (~/.ssh/config)
+
+  ```bash
+  Host github.com
+        Hostname ssh.github.com
+        Port 443 #如果你的网络环境不允许使用22端口进行连接
+        User git
+        ProxyCommand nc -v -x 127.0.0.1:10808 %h %p #如果需要使用代理才能访问互联网
+  ```
+
+---
+
+## 3。Git 最为基础的命令
+
+以下是 Git 中最基础且常用的命令，掌握这些命令是使用 Git 进行版本控制的第一步。
+
+### 初始化仓库（`git init`）
+
+- **命令**：
+
+  ```bash
+  git init
+  ```
+
+- **作用**：在当前目录中创建一个新的 Git 仓库。执行该命令后，Git 会在当前目录下生成一个隐藏的 `.git` 文件夹，用于存储版本控制所需的元数据和对象。
+- **使用场景**：当你需要从头开始创建一个新项目时，可以使用 `git init` 初始化仓库。
+
+### 克隆远程仓库（`git clone`）
+
+- **命令**：
+
+  ```bash
+  git clone <远程仓库地址>
+  ```
+
+- **作用**：从远程服务器（如 GitHub、Gitee 等）克隆一个已有的仓库到本地。克隆操作会将远程仓库的所有文件、分支和历史记录复制到本地。
+- **示例**：
+
+  ```bash
+  git clone https://github.com/example/project.git
+  ```
+
+- **使用场景**：当你需要参与一个已有的项目时，可以使用 `git clone` 将项目代码下载到本地。
+
+### 查看仓库状态（`git status`）
+
+- **命令**：
+
+  ```bash
+  git status
+  ```
+
+- **作用**：查看当前仓库的状态，包括哪些文件被修改、哪些文件已暂存（Staged）、哪些文件未跟踪（Untracked）等。
+- **输出示例**：
+
+  ```plaintext
+  On branch main
+  Changes not staged for commit:
+    (use "git add <file>..." to update what will be committed)
+    (use "git restore <file>..." to discard changes in working directory)
+      modified:   README.md
+
+  Untracked files:
+    (use "git add <file>..." to include in what will be committed)
+      new-file.txt
+
+  no changes added to commit (use "git add" and/or "git commit -a")
+  ```
+
+- **使用场景**：在提交代码之前，使用 `git status` 检查当前工作目录的状态，确保没有遗漏或误操作。
+
+---
+
+## 总结
+
+1. 如何配置 Git 的用户名和邮箱，以便正确标识代码贡献者。
+2. 如何使用 `git init` 初始化一个新的 Git 仓库。
+3. 如何使用 `git clone` 克隆远程仓库到本地。
+4. 如何使用 `git status` 查看仓库的当前状态。

docs/ch3/sec1/subsec2/2-staging.md

@@ -0,0 +1,111 @@
+# Git 暂存区
+
+## 目的
+
+本节旨在帮助学生理解 Git 暂存区的作用，并掌握 `git add` 等基础命令
+
+---
+
+## 内容
+
+### 1。Git 暂存区的作用
+
+#### 什么是暂存区？
+
+- **定义**：暂存区（Staging Area）是 Git 中一个临时存储区域，用于保存即将提交的更改。
+- **作用**：允许开发者选择性地将修改的文件添加到暂存区，而不是一次性提交所有更改。
+
+#### 工作流程
+
+1. **工作目录**：开发者对项目文件进行修改。
+2. **暂存区**：使用 `git add` 将修改的文件添加到暂存区。
+3. **本地仓库**：使用 `git commit` 将暂存区的内容提交到本地仓库。
+
+---
+
+### 2。修改暂存区
+
+`git add` 是 Git 中用于将工作目录中的修改添加到暂存区的命令。以下是 `git add` 的常见用法：
+
+#### 添加文件
+
+  **命令**：
+
+  ```bash
+  git add <文件1> <文件2>
+  ```
+
+  **作用**：将文件（如 `file1.txt` 和 `file2.txt`）添加到暂存区。
+
+#### 添加某个目录下的所有修改
+
+  **命令**：
+
+  ```bash
+  git add <目录名>/
+  ```
+
+  **作用**：将指定目录（如 `src/`）下的所有修改添加到暂存区。
+
+  如果你使用的是
+
+  ```bash
+  git .
+  ```
+  
+  那么将把当前所在目录的所有文件添加进暂存区
+
+???+ tip “小提示”
+    可以把构建产物的文件路径加入 `.gitignore` 文件中，避免被错误加入暂存区
+
+#### 交互式添加
+
+  **命令**：
+
+  ```bash
+  git add -p
+  ```
+
+  **作用**：进入交互模式，逐块（hunk）选择要添加到暂存区的修改。Git 会显示每个修改块，并提示是否将其添加到暂存区。
+  **使用场景**：当需要对修改进行精细控制时，可以使用交互式添加。
+
+??? tip “类比一下”
+    git rm，git mv 的用法与 git add 差不多
+
+---
+
+### 3。撤销暂存区的修改
+
+如果误将某些修改添加到暂存区，可以使用以下命令将其撤销：
+
+#### 撤销单个文件的暂存
+
+  **命令**：
+
+  ```bash
+  git restore --staged <文件名>
+  ```
+
+  **示例**：
+
+  ```bash
+  git restore --staged README.md
+  ```
+
+  **作用**：将指定文件（如 `README.md`）从暂存区移回工作目录。
+
+#### 撤销所有暂存的修改
+
+  **命令**：
+
+  ```bash
+  git restore --staged .
+  ```
+
+  **作用**：将所有暂存的文件移回工作目录。
+
+## 总结
+
+通过本节的学习，学生应掌握以下内容：
+
+1. **暂存区的基础操作**

mkdocs.yml

@@ -99,6 +99,8 @@ nav:
         - 创建并管理仓库: ch3/sec1/subsec1/4-create-repo.md
         - 开源许可证选择指南: ch3/sec1/subsec1/5-open_source_License.md
       - 基础阶段:
+        - Git的基础配置: ch3/sec1/subsec2/1-basic-configuration.md
+        - 暂存区操作: ch3/sec1/subsec2/2-staging.md
         - 如何写好一个commit message: ch3/sec1/subsec2/6-commit-message.md
       - 专业阶段:
         - Git Rebase与Git Merge的使用与区别: ch3/sec1/subsec3/1-rebase-merge.md