mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
82d887df98
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
76 lines
4.1 KiB
Plaintext
76 lines
4.1 KiB
Plaintext
---
|
||
title: "编辑器中的 Git 基础"
|
||
sidebarTitle: "Git 基础"
|
||
description: "了解 Mintlify 编辑器背后的 Git 版本控制概念，包括 branch、commit、拉取请求和合并工作流。"
|
||
keywords: ["git", "版本控制", "Web 编辑器", "分支", "提交", "拉取请求（PR）", "PR"]
|
||
---
|
||
|
||
Git 让你可以控制并跟踪文件的变更。Git 是 docs-as-code 工作流中的首选版本控制系统，在这种工作流中，你会像管理其他任何代码库一样管理文档。
|
||
|
||
Web 编辑器会替你处理 Git 操作。理解几个关键概念有助于你更好地发挥编辑器的作用，并更高效地与团队协作。
|
||
|
||
<div id="what-git-does-for-your-docs">
|
||
## Git 为文档做什么
|
||
</div>
|
||
|
||
Git 会跟踪对文档所做的每一次更改。它会记录更改了什么、是谁更改的、何时更改的，以及为什么更改。这意味着你可以：
|
||
|
||
- 查看任意页面的完整历史记录。
|
||
- 通过回退到先前版本来撤销更改。
|
||
- 在不影响线上站点的情况下进行更新。
|
||
- 在更改上线之前先进行审查。
|
||
|
||
你的文档存储库是构成文档站点的文件及其历史记录的集合。Web 编辑器会连接到此存储库，以同步并发布你的内容。
|
||
|
||
<div id="key-concepts">
|
||
## 关键概念
|
||
</div>
|
||
|
||
这些是你在使用 Web 编辑器时最常接触到的 Git 概念。
|
||
|
||
<AccordionGroup>
|
||
<Accordion title="提交">
|
||
在特定时间点保存的更改快照。每次提交都包含一条描述更改内容的消息，并在你的项目历史中创建一条永久记录。
|
||
|
||
当你发布更改时，Web 编辑器会在你的 Git 存储库中创建一次提交。
|
||
</Accordion>
|
||
<Accordion title="分支">
|
||
存储库中的一条独立工作线路，有时称为 **功能分支（feature branch）**。
|
||
|
||
你的在线文档是从一个 **部署用分支** 构建的，通常名为 `main`。其他分支让你可以独立进行修改，而不影响你的线上站点。在将某个分支通过拉取请求合并到部署用分支之前，该分支上的任何内容都不会上线。
|
||
|
||
通过编辑器工具栏中的分支下拉菜单在不同分支之间切换。如果你有未发布的更改，编辑器会让你选择将更改带到新分支或保留在当前分支。
|
||
</Accordion>
|
||
<Accordion title="部署用分支">
|
||
用于构建你的线上文档站点的分支，通常名为 `main`。合并到该分支的更改会自动部署到你的站点。
|
||
</Accordion>
|
||
<Accordion title="拉取请求（PR；亦称“合并请求”/Merge Request）">
|
||
一个将更改从一个分支合并到另一个分支的提案。拉取请求可以让你的团队在更改上线之前进行审查和讨论。
|
||
|
||
当你在功能分支上发布更改时（或当你的存储库要求使用拉取请求时），Web 编辑器会创建一个拉取请求。你的团队会在 Git 提供商（GitHub 或 GitLab）中审查并合并该拉取请求。
|
||
</Accordion>
|
||
<Accordion title="合并">
|
||
将一个分支中的更改合并到另一个分支中。在你的团队审查并批准拉取请求之后，合并该分支会把你的更改纳入部署用分支并发布。
|
||
</Accordion>
|
||
<Accordion title="冲突">
|
||
当两个分支对相同文件包含不兼容的更改时就会发生冲突。编辑器会在冲突发生时帮助你解决它们。
|
||
</Accordion>
|
||
<Accordion title="差异（Diff）">
|
||
显示文件两个版本之间差异的对比视图。编辑器会在你发布之前显示待提交更改的可视化差异，便于你准确审阅将要提交的内容。
|
||
</Accordion>
|
||
</AccordionGroup>
|
||
|
||
<div id="how-the-editor-maps-to-git">
|
||
## 编辑器如何映射到 Git
|
||
</div>
|
||
|
||
在 Web 编辑器中的每一次发布操作都对应一次 Git 操作。
|
||
|
||
| 你在编辑器中的操作 | 背后对应的 Git 操作 |
|
||
|---|---|
|
||
| 编辑页面 | 更改会自动保存到 Mintlify 服务器（尚未进行 Git 提交） |
|
||
| 切换 branch | 切换到所选的 branch |
|
||
| 在部署用分支上发布 | 将更改提交到你的存储库并触发一次部署 |
|
||
| 在功能 branch 上发布 | 提交更改并创建一个拉取请求 |
|
||
| 外部 push 或 CLI 更新 | 传入的更改会自动同步到编辑器中 |
|