# siyuan-plugin-git-sync

**Repository Path**: dancingrain/siyuan-plugin-git-sync

## Basic Information

- **Project Name**: siyuan-plugin-git-sync
- **Description**: 思源笔记 git 同步插件
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-05
- **Last Updated**: 2025-10-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Git 同步插件

该插件用于同步 [思源笔记](https://www.siyuan-note.com/) 的数据目录到远程 Git 仓库。原理是执行 git 命令，在思源笔记界面上提供 git 操作的可视化界面

## 注意事项

1. 本地必须安装 git 环境
2. 同步的目录必须是 git 本地仓库，并配置好远程仓库地址
3. 本插件**不会自动同步**，仅仅是封装一个可视化界面，便于手动执行 git 操作

> 本插件基于模板开发，地址：[plugin-sample-vite-vue](https://github.com/siyuan-note/plugin-sample-vite-vue)

## 安装

1. 打开思源笔记的工作空间 workspace
2. 将插件压缩包 package.zip 解压至 {workspace}/data/plugins 目录下
3. 将解压后的文件夹命名为 siyuan-plugin-git-sync
4. 在 `设置 -> 集市` 中启用插件

## 配置

在插件设置中填写以下信息：

- `Git 仓库地址`：Git 本地仓库绝对路径，建议为思源笔记工作空间的 data 目录
- `远程分支名称`：要同步的分支名称，默认为 `master`
- `合并策略`：执行 git pull 时的合并策略，默认为 `merge`
- `提交信息模板`：提交时的备注信息

## 功能

1. 提交并推送：`git add .` + `git commit` + `git push -u origin`
2. 拉取远程仓库：`git pull`
3. 提交本地仓库：`git commit`
4. 推送本地仓库：`git push`

注意：插件首次启动时会执行 git pull 操作，暂时无法手动关闭

## 使用

插件安装并配置完成后，可以通过顶部插件菜单完成 git 操作

## 贡献

欢迎贡献代码和提出建议。请先 fork 本项目，提交 PR 或 issue

## 许可证

本项目使用 MIT 许可证。详情请查看 LICENSE 文件