使用Git管理文檔 · 接口文檔管理系統

[toc=2] # 什么是Git? * Git是一個分布式版本管理系統 * Git可以在任何時間點，把文檔的狀態作為更新記錄保存起來。 * 可以把編輯過的文檔恢復到以前的狀態，也可以顯示編輯前后的內容差異。 # Git管理的有哪些好處? * 發布更方便 * 查找更輕松 * 查看文檔修改歷史,并支持代碼回滾 # 安裝Git * 下載[Git](https://git-scm.com/downloads) * 安裝(一直下一步即可) # 什么是Git分區? ```[sequence] participant 工作區 as work participant 暫存區 as stage participant 本地倉庫 as local participant 遠程倉庫(看云) as remote work->stage:$ git add stage->local:$ git commit local->remote:$ git push remote-->work:$ git pull ``` # Git常用命令速查表 ![](https://box.kancloud.cn/09973be6898965d9eb3f94c929120015_1099x718.png) # 使用Git管理接口文檔 ## 設置Git用戶名和郵箱 ``` $ git config --global user.name "John Doe" $ git config --global user.email johndoe@example.com ``` ## 把看云上的文檔下載到本地 > 如果詢問用戶名和密碼, 填上看云的用戶名和密碼即可 ``` $ git clone https://git.kancloud.cn/yanshandou/kam.git ``` ## 新增/修改/刪除文檔并上傳到看云 ``` $ git add . $ git commit -m 'this is a commit' $ git push ``` ## 在看云上修改文件并同步到本地 ``` $ git pull ``` ## 解決本地和看云的文檔沖突 ``` $ git pull ``` ``` 修改沖突文件... ``` ``` $ git add . $ git commit -m 'this is a commit' $ git push ``` ## 如何避免沖突 > 先同步再修改 ## 使用git查看文檔修改歷史 ``` $ git log --pretty=oneline filename $ git show 哈希值(最少前四位) ``` ## 使用看云查看文檔修改歷史 ![](https://box.kancloud.cn/4ebaf6706b5ae8673cfba6150d8c8abd_218x94.png) ![](https://box.kancloud.cn/f0631ed0a7a0b7a4811c75ae157ed0dc_818x527.png) ![](https://box.kancloud.cn/d60f8e00c4fafdf517a7fbe8502fbd60_1920x950.png) ![](https://box.kancloud.cn/2cce29cb04bd5412ce17d3d8f6f26e95_1920x911.png) ## 文檔內容回滾 ``` $ git reset 哈希值文件名 $ git commit -m 'commit' $ git checkout 文件名 $ git push ``` # vscode簡化操作 ## 新增/修改/刪除文檔并上傳到看云 ![](https://box.kancloud.cn/09af8dd99a02058c8e4ec17e579090fd_997x350.png) ![](https://box.kancloud.cn/44c307a04f3c0c5ae63ffe4692a3adcd_1481x315.png) ![](https://box.kancloud.cn/220b78b8917a3abdc0911b27d948dd63_434x164.png) ![](https://box.kancloud.cn/9e53c29bae169460c81010c80d2f57c2_609x689.png) ## 在看云上修改文件并同步到本地 ![](https://box.kancloud.cn/f3aa8f4b83a62fba101880b04f670e58_216x96.png) ![](https://box.kancloud.cn/76c3ee052c2b58d7d723eddfd7e65924_608x710.png) ## 解決本地和看云的文檔沖突 ![](https://box.kancloud.cn/0d4d2ce75fde5871ea094d999d873c3c_785x194.png) ![](https://box.kancloud.cn/a89c630ee24b16cb2d808f515ad53893_839x251.png) ![](https://box.kancloud.cn/2e55b874e5927e59102dfa281879d559_442x124.png) ![](https://box.kancloud.cn/2fc75c456dacd4d2b11172aef01fce74_650x707.png) ![](https://box.kancloud.cn/ecdf105e0d46fe9708601e1e1df43ba6_778x262.png) ## 查看文檔修改歷史 > 安裝插件`GitLens` ![](https://box.kancloud.cn/3c48d30881e93a3fdf0a1fdacca50b35_1350x556.png) ![](https://box.kancloud.cn/3786d8bdf03d316aafbc338ce3a0c5bd_1920x997.png) ![](https://box.kancloud.cn/e1981b766e1c1cbce1ef5bc13947b2d1_681x438.png) ![](https://box.kancloud.cn/af1c2a9f2924a511c61c50a5eb0c460d_432x689.png) ## 文檔內容回滾 ![](https://box.kancloud.cn/8c4b68c965d1518b292f8001e4bbe3b7_516x660.png) # 擴展閱讀 * [猴子都能懂的GIT入門](https://backlog.com/git-tutorial/cn/intro/intro1_1.html) * [Git圖解](http://marklodato.github.io/visual-git-guide/index-zh-cn.html?no-svg#basic-usage)