# sy-git-sync-plugin

**Repository Path**: xstarling/sy-git-sync-plugin

## Basic Information

- **Project Name**: sy-git-sync-plugin
- **Description**: 思源笔记的GIT同步插件
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-17
- **Last Updated**: 2025-08-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GIT同步插件

[English](./README.md)

GIT同步插件是一个由 `xstarling` 开发的用于本地文件和GITHUB、GITEE代码仓库平台进行数据同步的插件。

## 更新日志

#### 历史版本更新

* 请点击查看更新日志文档：[更新日志](https://kdocs.cn/l/caGt3BWn9r5G?linkname=ihqHHyiJ56)

#### 当前版本更新

1. 新增功能：用户自定义同步到git仓库的 `assets/` 资源文件的路径
2. 新增功能：用户下拉菜单，选择更新本地资源文件（恢复因为配置 `assets/`资源文件路径导致本地资源不能正常显示），刷新工作树（恢复因为数据同步后，部分新增笔记的ID不能找到的问题）
3. 修复BUG：修复上次更新后，部分用户反馈同步数据提示【`请初始化远端仓库 / 检查设置界面的token配置是否正确 / 检查网络连接`】的问题
4. 优化功能：优化全局异常处理和日志文件

## 功能列表

> 功能列表：[点击查看](https://kdocs.cn/l/caGt3BWn9r5G?linkname=k7VAb4Wx5b)

+ **🚧大文件同步（开发中）**
  + 🚀将git仓库和百度网盘、阿里网盘等结合起来，实现大文件上传同步
+ **🚧功能菜单**
  + 🚀开始同步：启动本地与远端的数据同步
  + 🚀刷新/更新数据：

    + 👉刷新工作树：若同步后，本地新增的文件出现【ID未找到！】的问题，可以通过刷新工作树解决
    + 👉更新资源路径：若配置配置 `assets/`资源文件路径，导致本地资源不能正常显示，可以通过此按钮恢复
  + 🚀同步范围：

    + 👉工作空间：工作空间中，重要的数据均会被同步到git仓库
    + 👉数据目录（data目录）：工作空间中，`data`目录下存放的数据文件会被同步到git仓库
    + 👉笔记文件：工作空间中，`data`目录的的思源笔记的文件和 `asset`图片资源文件
  + 🚀同步策略：

    + 👉自动同步：系统自动的同步策略实现文件对比同步
    + 👉手动同步：弹框允许用户自己手动【云端覆盖本地】、【本地覆盖云端】，并勾选强制覆盖还是非强制覆盖
    + 👉云端覆盖本地：非强制覆盖模式，从远端覆盖本地，若文档冲突会生成冲突文档（若勾选了生成冲突文档选项，否则弹框提示）
    + 👉本地覆盖云端：非强制覆盖模式，从本地覆盖远端，若文档冲突会生成冲突文档（若勾选了生成冲突文档选项，否则弹框提示）
  + 🚀笔记格式：

    + 👉思源笔记：同步到远端仓库的文件为思源格式的笔记（仅笔记文件，其他文件不支持）
    + 👉markdown：同步到远端仓库的文件为markdown格式的笔记（仅笔记文件，其他文件不支持）
  + 🚀同步模式：

    + 👉自动同步：会根据设置界面中设定的时间间隔，定时同步数据到git仓库
    + 👉手动同步：仅在系统启动的时候会同步一次，系统关闭时不会触发同步
    + 👉完全手动同步：在系统启动和系统关闭时均不会触发同步，需要手动点击【开始同步】按钮才会同步
  + 🚀同步历史：

    + 👉本地提交：选择后，系统会查询截止到本机设备上次提交之前的远端git仓库的所有提交记录
    + 👉远端提交：选择后，系统会查询截止到现在，远端git仓库的所有提交记录
    + 👉搜索文件：用户可以根据筛选的笔记本，文件ID或路径，时间范围来搜索包含对应文件的提交记录
    + 👉提交节点：鼠标移动到侧边栏的提交记录中的提交节点上，系统会提示提交的摘要信息
    + 👉提交文件：点击【提交节点】后，【同步历史】面板的右侧会展示提交节点的文件列表
    + 👉文件对比：点击【提交文件】后，系统会打开文件对比面板，同时展示提交节点的文件内容和本地同名的文件内容，方便用户对比文件内容的差异
    + 👉回滚文件：提交文件列表中，有个【⤴︎】，点击后，提交记录中的文件会被下载到本地，并且覆盖本地的文件内容
    + 👉下载文件：提交文件列表中，有个【↓】，点击后，提交记录中的文件会被下载到本地，并且右侧弹框会提示下载的路径
+ **🚧设置界面**
  + 🚀用户信息：包括【git仓库平台】、【git仓库地址】、【git仓库名称】、【git仓库分支名】、【git平台用户名】、【邮箱】，这些信息用户根据自己平台信息填写正确完整后，插件系统才可以使用
  + 🚀忽略文件：用户将不需要同步的文件的路径或文件名填写这里，系统同步时会自动忽略相关文件
  + 🚀资源文件路径(必须以【assets/】结尾）：用户配置后，可以将同步到平台的文件中的资源文件链接的 `assets/`替换为自定义的路径前缀
  + 🚀令牌/SSH: 用户登录自己的github或gitee仓库，生成自己的token，用于系统远程访问git仓库
  + 🚀同步冲突时生成冲突文档：
  + 🚀同步范围：见【功能菜单】-> 【同步范围】
  + 🚀同步模式：见【功能菜单】-> 【同步模式】
  + 🚀同步间隔：用户设定【自动同步】时，系统同步的时间间隔
  + 🚀上次提交SHA值：展示用户上次提交的记录的哈希值，不可修改
  + 🚀上次提交时间：展示用户在本机上次提交的时间，不可修改

## 使用说明

> 详细使用说明请移步：[GIT同步插件使用说明](https://kdocs.cn/l/caGt3BWn9r5G?linkname=ArymAS7rZm)

## 注意事项

> [GIT同步插件-免责声明](https://kdocs.cn/l/caGt3BWn9r5G?linkname=hMZxlMSs8z) <br>
> 本软件（以下简称“本软件”）由个人开发，旨在为用户提供笔记数据同步功能。使用本软件即表示您已阅读、理解并同意本免责声明的全部内容。

+ 💻1. 数据安全

  + 🚀由于本插件为个人开发，系统测试可能有限，**建议用户启用思源笔记的快照功能或定期备份数据**，以防数据丢失。
  + 🚀希望用户应理解并接受，**使用本插件可能存在不可预见的风险**，如：数据丢失、损坏或同步错误。在适用法律允许的范围内，请用户用户应自行评估使用风险。
+ 💻2. 隐私与权限

  + 🚀本软件不会主动收集、存储或共享用户的个人信息，所有数据处理均在用户设备本地或用户授权的 Git 代码仓库中进行。
  + 🚀 用户应妥善管理自己的 Git 账户、API 令牌（Token）及相关凭据，并对其数据安全和访问权限负责。
+ 💻3. 使用风险

  + 🚀 用户须自行承担使用本软件的风险，开发者不对因使用本软件引发的任何直接或间接损失承担责任，包括但不限于数据丢失、账户封禁、设备损坏或第三方责任等。
+ 💻4. 其他

  + 🚀 其他注意事项，请详见插件的【设置界面】中的【免责声明】或 [GIT同步插件-免责声明](https://kdocs.cn/l/caGt3BWn9r5G?linkname=hMZxlMSs8z)

## 项目管理

1. 功能列表：[点击查看](https://kdocs.cn/l/caGt3BWn9r5G?linkname=k7VAb4Wx5b)
2. 使用说明：[点击查看](https://kdocs.cn/l/caGt3BWn9r5G?linkname=ArymAS7rZm)
3. 免责声明：[点击查看](https://kdocs.cn/l/caGt3BWn9r5G?linkname=hMZxlMSs8z)
4. 开发进度：[点击查看](https://kdocs.cn/l/caGt3BWn9r5G?linkname=Emg3LXgDJp)
5. 反馈沟通：[👥思源-git同步插件反馈群（QQ群：1015180920）](https://kdocs.cn/l/caGt3BWn9r5G?linkname=Ij7mC9wG6q)
6. 常见问题答疑：[FAQ文档](https://kdocs.cn/l/cf8qSfWUdi1O)