​
在此之前你已经在gitee创建好了账号，并新建了一个仓库。

1. 安装 Visual Studio Code

---

Visual Studio Code 是编辑 Markdown 和站点配置文件的基础，以下将其简称为 VSCode，你可以在它的 官方网站 下载到它。

如若不理解各个版本之间的区别，请下载下图中指示的版本（Windows System Installer x64）：

2. 安装 Git

---

Git 是将所作的变更上传到仓库、拉取运行环境、进行差异追踪所必要的工具，你可以在它的 官方网站 下载到它。

在官方下载页面的右侧，点击 Download for Windows 即可下载：

3. 安装 Node.js

---

Node.js 是本地编译和运行文档服务器所必要的运行环境软件，你同样可以在它的 官方网站 下载到它。

官方下载页是一个引导式的交互页面，如无特殊需求，按照如下选择即可：

I want Current version of Node.js for Windows running x64

然后点击 Download Node.js 按钮下载 Node.js 安装程序。

4. 拉取指定文档仓库到本地

1. 在开始拉取之前，需要首先在自己的本地磁盘内创建一个用于保存所有文档仓库的子文件夹。例如，你可以在 D: 盘下创建一个名为 PixelClock 的子文件夹。

请尽量不要在路径内包含 空格 非 ASCII 字符，以免在后续操作中引发意外情况。

2. 创建完成后，打开 Windows PowerShell 工具（右键点击 Windows 徽标键 并选择 Windows PowerShell (管理员) 选项）。
3. 在 Windows PowerShell 内导航到刚才创建的文件夹下，本例中为 D:\PixelClock文件夹，则执行 cd "D:\PixelClock"：
   

此处的双引号 "" 为英文半角字符，如果路径内包含 空格，则双引号不能省略。

​4. 根据要拉取的文档仓库，执行以下命令之一：

git clone --depth=1 https://gitee.com/laoguaige/esp32-s3-r8-n8-pixel-clock.git

因为代码仓库是私有的，所以在以上命令执行的中途会弹出窗口提示你输入凭据以登录到指定的 Git 仓库，请将你的 gitee账号用户名称 与 账号登录密码 提交给它。Git 将会保存该凭据以备下次连接到相同仓库时使用。

5. 获取 VS Code 扩展

---

VS Code 扩展配合仓库内已配置好的一撮魔法粒子，可以释放自动规范文档格式、纠正语法错误等技能~

1. 首先需要启动 VS Code，并在其内部打开在上一阶段拉取到的项目的文件夹（例如 D:\PixelClock\esp32-s3-r8-n8-pixel-clock）。
   
2. 然后切换到扩展页面（快捷键 Ctrl+Shift+X），在顶部搜索框搜索并安装以下应用程序：
   1. Code Spell Checker by Street Side Software
   2. Prettier by Prettier
   3. EditorConfig for VS Code by EditorConfig
   4. Markdown All in One by Yu Zhang
   5. Markdown Image by Hancel.Lin
   6. Git Graph by mhutchie

6. 提交修改

6.1 什么是git

Git 是一个文件版本控制系统，用于管理整个仓库（命名空间）中所有文件的增删改，它以每个提交作为单位忠实地记录每个文件在其生命周期里被进行的所有操作，在正确的使用方法下，你可以查询到每个文件中每一行内容是由哪个人在哪个时间点新增、修改的，任何意外的删除操作也可以通过时间线查询的方式找回其历史的版本。

除此外，还有几个容易被混淆东西：

• GitHub.com | 这是一个由 Microsoft 公司维护的公共 Git 仓库托管服务（当然还有很多其它衍生的服务），简单地来说，就是能让你把 Git 所管理的文件放在它提供的服务器上
• GitLab.com、Coding.net、Gitee.com | 同上，均是由不同公司运营的功能相近的 Git 仓库托管服务
• Git 客户端 | 可以安装在各大操作系统上的 Git 客户端，是用于管理 Git 仓库内文件的工具

6.2 在 VS Code 内暂存当前被修改的文件

此处被修改的文件，指的是你 本地的文件 与 上一次拉取云端仓库的文件 之间的差异，这个差异在 Git 系统上被称为 diff。
为了查看当前被修改的文件，你需要在 VS Code 内切换到源代码管理（快捷键 Ctrl+Shift+G）模块，它通常位于页面左侧：

在出现的源代码管理标签页下，可以看到类似如下的内容：

点击每一个更改，都将会打开新的页面，页面内已使用醒目的颜色标识出了修改前和修改后的差异之处，通常情况下，红色表示移除，绿色表示新增。

如果认为该文件的修改没有问题，请将该修改添加到暂存，该操作在 Git 系统上被称为 add。

6.3. 拉取云端仓库

在提交内容前，我们通常还需要进行一步中间操作，即 Git 拉取，这个操作在 Git 系统上被称为 pull。额外进行一步这个操作是因为一个 Git 仓库通常会由多个人同时进行维护，大家在同一个仓库内对文件进行修改难免会出现一些冲突，此时我们应该遵循先来后到的原则，将云端由别人提交的变更拉取到本地，确定没有冲突之后，再将我们本地的所有变更推送到云端。
如果想要避免更加难以解决的冲突，请在开始撰写文档之前进行必要的分工，让大家 不要 同时编辑同一个文件。

使用 VS Code 的 Git Graph 拓展可以查看 Git 提交历史，进行分支合并等操作，可以按需自行选择安装。

想要拉取云端仓库，可以在源代码管理标签页下使用 拉取功能快捷进行：

6.4. 提交本地变更

你完整地检查了所有修改的文件并确保它们不包含隐私信息、无云端冲突后，就可以进行将所有的变更安全地提交到云端仓库了。

在源代码管理标签页内，为本次提交添加提交消息，简略描述你本次所作的更改的内容，并点击 提交并推送 选项：

这里其实进行了两步操作，提交 commit 和推送 push，你也可以累积多次提交后再手动一次性推送，这里不再赘述。