Obsidian Git Sync 插件

这是一个为Obsidian设计的Git同步插件,可以帮助您轻松地将Obsidian笔记与Git仓库同步。

功能

• 自动检测本地和远程的更改
• 一键同步本地更改到Git仓库
• 从Git仓库拉取最新更新
• 可自定义同步按钮位置
• 提供详细的同步状态提示
• 支持定期自动同步
• 支持失去焦点时同步

安装

1. 打开Obsidian设置
2. 进入"第三方插件"
3. 禁用"安全模式"
4. 点击"浏览社区插件"
5. 搜索"Git Sync"
6. 点击安装
7. 启用插件

使用方法

1. 安装并启用插件后,进入插件设置
2. 设置Git仓库的本地路径
3. 选择同步按钮的显示位置(左侧功能区或状态栏)
4. 点击同步按钮或使用命令面板执行"执行Git同步"命令来同步您的笔记

设置选项

• Git仓库路径: 设置您的Obsidian仓库对应的本地Git仓库路径
• 同步按钮位置: 选择将同步按钮放置在左侧功能区还是状态栏
• 启用自动同步: 开启或关闭定期自动同步功能
• 自动同步间隔: 设置自动同步的时间间隔（分钟）
• 失去焦点时同步: 当Obsidian窗口失去焦点时执行同步

注意事项

• 请确保您的系统已安装Git
• 首次使用时,请确保已正确配置Git仓库
• 如果遇到权限问题,可能需要配置SSH密钥或使用个人访问令牌

常见问题

Q: 为什么同步失败? A: 请检查Git仓库路径是否正确,以及是否有足够的权限访问仓库。

Q: 插件会自动同步吗? A: 默认情况下不会,但您可以在设置中启用"启用自动同步"选项并设置同步间隔。您还可以选择在Obsidian窗口失去焦点时进行同步。

自动同步

本插件提供了灵活的自动同步功能,您可以根据个人需求选择启用或禁用以下选项:

1. 定期自动同步: 在设置中启用"启用自动同步"并设置同步间隔,插件将按照设定的时间间隔自动执行同步。
2. 失去焦点时同步: 如果启用此选项,当Obsidian窗口失去焦点时会自动执行同步操作。

这些自动同步功能都是可选的,您可以随时在设置中开启或关闭它们,以适应您的工作流程。

支持

如果您在使用过程中遇到任何问题或有任何建议,请在GitHub上提交issue。

贡献

欢迎提交Pull Request来改进这个插件。

许可证

本插件采用MIT许可证。详情请见LICENSE文件。