mirror of
https://github.com/firstsun-dev/git-files-sync.git
synced 2026-07-22 17:20:30 +00:00
docs: update USAGE_zh.md with Gitea support and provider compatibility table
https://claude.ai/code/session_019Jbz6HpQvWU1wpm5M6MZpd
This commit is contained in:
parent
6afeaf673d
commit
615819c39e
1 changed files with 22 additions and 7 deletions
29
USAGE_zh.md
29
USAGE_zh.md
|
|
@ -2,7 +2,21 @@
|
|||
|
||||
<video src="imgs/git-file-sync-zh.webm" width="100%" controls autoplay loop muted playsinline></video>
|
||||
|
||||
本指南將引導您如何使用 Git File Sync 插件,在行動裝置與桌面電腦之間,透過 GitLab 或 GitHub 輕鬆同步您的筆記。
|
||||
本指南將引導您如何使用 Git File Sync 插件,在行動裝置與桌面電腦之間,透過 GitLab、GitHub 或自架的 Gitea 輕鬆同步您的筆記。
|
||||
|
||||
---
|
||||
|
||||
## 支援的 Git 服務
|
||||
|
||||
<img src="https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github&logoColor=white" alt="GitHub" height="28">
|
||||
<img src="https://img.shields.io/badge/GitLab-FC6D26?style=for-the-badge&logo=gitlab&logoColor=white" alt="GitLab" height="28">
|
||||
<img src="https://img.shields.io/badge/Gitea-609926?style=for-the-badge&logo=gitea&logoColor=white" alt="Gitea" height="28">
|
||||
|
||||
| | 服務 | 適用情境 | 最低版本 |
|
||||
| :---: | :--- | :--- | :--- |
|
||||
| <img src="https://img.shields.io/badge/GitHub-181717?style=flat-square&logo=github&logoColor=white" alt="GitHub"> | **GitHub** | 公開 / 私人儲存庫 | — |
|
||||
| <img src="https://img.shields.io/badge/GitLab-FC6D26?style=flat-square&logo=gitlab&logoColor=white" alt="GitLab"> | **GitLab** | gitlab.com 或自架 | GitLab 13.0+ |
|
||||
| <img src="https://img.shields.io/badge/Gitea-609926?style=flat-square&logo=gitea&logoColor=white" alt="Gitea"> | **Gitea** | 自架 Git 伺服器 | Gitea 1.12+ |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -13,10 +27,11 @@
|
|||

|
||||
*在設定面板選擇您的 Git 服務並填入對應的憑證與路徑。*
|
||||
|
||||
1. **選擇服務**:在 `設定` > `Git File Sync` 中選擇 GitLab 或 GitHub。
|
||||
1. **選擇服務**:在 `設定` > `Git File Sync` 中選擇 GitLab、GitHub 或 Gitea。
|
||||
2. **填寫憑證**:
|
||||
- **GitHub**:需要 個人存取權杖 (PAT)、帳號名稱、儲存庫名稱。
|
||||
- **GitLab**:需要 個人存取權杖 (PAT)、專案 ID、伺服器網址 (預設為 gitlab.com)。
|
||||
- **GitHub**:需要 個人存取權杖 (PAT)、帳號名稱、儲存庫名稱。權杖需具備 `repo` 權限。
|
||||
- **GitLab**:需要 個人存取權杖 (PAT)、專案 ID、伺服器網址(預設為 `https://gitlab.com`,自架請改為您的網址)。權杖需具備 `api` 權限。
|
||||
- **Gitea**:需要 個人存取權杖 (PAT)、伺服器網址(例如 `https://gitea.example.com`)、帳號名稱、儲存庫名稱。權杖在 `使用者設定` > `應用程式` > `存取權杖` 中建立。
|
||||
3. **儲存庫路徑**:如果您想將筆記存放在儲存庫的特定資料夾(例如 `notes/`),請在 `Root Path` 中設定。
|
||||
|
||||
---
|
||||
|
|
@ -41,7 +56,7 @@
|
|||
當您寫完筆記,想備份到雲端時:
|
||||
- **單一檔案**:
|
||||
- 點擊左側功能列的 **雲端上傳圖示**。
|
||||
- 或者在檔案列表點擊右鍵,選擇 `Push to GitLab/GitHub`。
|
||||
- 或者在檔案列表點擊右鍵,選擇 `Push to GitLab/GitHub/Gitea`。
|
||||
- **批量上傳**:
|
||||
- 在同步面板勾選多個檔案,點擊下方的 **Push selected**。
|
||||
|
||||
|
|
@ -50,7 +65,7 @@
|
|||
### ⬇️ 如何下載(Pull)
|
||||
當您在另一台裝置更新了筆記,想同步回目前裝置時:
|
||||
1. 打開同步面板,點擊 **Refresh status**。
|
||||
2. 找到顯示為 **Remote only** 或 **Modified** (雲端版本較新) 的檔案。
|
||||
2. 找到顯示為 **Remote only** 或 **Modified**(雲端版本較新)的檔案。
|
||||
3. 勾選後點擊 **Pull selected**。
|
||||
4. **注意**:Pull 會覆蓋掉您本機的內容。如果有衝突,會自動開啟衝突解決視窗。
|
||||
|
||||
|
|
@ -79,5 +94,5 @@
|
|||
|
||||
## 🔒 隱私與安全
|
||||
|
||||
- 您的存取權杖 (Token) 僅會儲存在您本機的 Obsidian 資料夾內。
|
||||
- 您的存取權杖 (Token) 僅會儲存在您本機的 Obsidian 資料夾內,不會傳送至任何第三方伺服器。
|
||||
- 本插件不會收集任何個人數據或使用紀錄。
|
||||
|
|
|
|||
Loading…
Reference in a new issue