一、准备工作
在开始前,需完成以下基础配置:
-
安装 Git 客户端:前往 Git 官网 下载并安装(Windows/Mac/Linux 均支持)。
-
获取远程仓库地址:
- 登录 GitHub/Gitee 等代码托管平台,找到目标仓库。
- 点击「Code」按钮,复制 HTTPS 地址(推荐新手)或 SSH 地址(需配置 SSH 密钥)。
二、克隆仓库到本地
通过 git clone 命令将云端仓库下载到本地,避免在 Obsidian 内部操作,使用系统终端执行:
步骤 1:打开终端
- Windows:右键点击仓库目标文件夹,选择「Git Bash Here」;
- Mac/Linux:打开终端,
cd到目标文件夹。
步骤 2:执行克隆命令
git clone 你的仓库地址
- 替换为复制的 HTTPS/SSH 地址(例如:
git clone https://github.com/BBNT-1215/bbnt_vault_obs.git) 。
步骤 3:处理 SSH 指纹问题(仅 SSH 方式)
若使用 SSH 地址,首次克隆会提示:
The authenticity of host 'github.com (20.205.243.166)' can't be established.
...
Are you sure you want to continue connecting (yes/no/[fingerprint])?
- 输入
yes并回车,将 GitHub 的 SSH 密钥添加到本地信任列表(后续连接不再提示)。
步骤 4:等待克隆完成
终端显示克隆进度,完成后会在目标文件夹生成与仓库同名的文件夹(如 bbnt_vault_obs)。
三、用 Obsidian 打开本地仓库
- 打开 Obsidian,点击左下角「打开仓库」→「打开本地仓库文件夹」。
- 选择克隆生成的文件夹(注意:选中包含
.git隐藏文件夹的目录),点击「打开」。
四、安装并启用 Git 插件
- 进入 Obsidian 设置:点击左下角齿轮图标 →「第三方插件」。
- 关闭「安全模式」(首次使用需关闭)。
- 点击「浏览」→ 搜索
Git→ 安装由「Vinzent」开发的「Obsidian Git」插件。 - 安装完成后,点击「启用」。
五、配置 Git 插件实现自动同步
自动同步需同时开启「远程→本地(拉取)」和「本地→远程(提交+推送)」功能,配置如下:
1. 自动拉取(远程→本地)设置
确保本地库能及时获取云端更新:
-
Pull on startup(启动时拉取):
- 位置:
设置 → Git → Pull 页面→ 开启开关(紫色)。 - 作用:每次打开 Obsidian 时,自动从远程仓库拉取最新内容。
- 位置:
-
Auto pull interval (minutes) (自动拉取间隔):
- 位置:
设置 → Git → Automatic 页面→ 输入框设为2(或自定义,如5分钟)。 - 作用:每隔指定时间自动拉取远程更新。
- 位置:
2. 自动提交同步(本地→远程)设置
确保本地修改能及时同步到云端:
-
Auto commit-and-sync interval (minutes) (自动提交同步间隔):
- 位置:
设置 → Git → Automatic 页面→ 输入框设为5(或自定义,如10分钟)。 - 作用:每隔指定时间自动提交本地更改并推送到远程。
- 位置:
-
Auto commit-and-sync after stopping file edits(停止编辑后自动同步):
- 位置:
设置 → Git → Automatic 页面→ 开启开关(紫色)。 - 作用:停止编辑文件后,自动触发提交和同步,避免手动遗漏。
- 位置:
-
Push on commit-and-sync(提交同步时推送):
- 位置:
设置 → Git → Pull 页面→ 开启开关(紫色)。 - 作用:确保
commit-and-sync操作包含「推送」步骤,实现本地→远程同步。
- 位置:
-
Pull on commit-and-sync(提交同步时拉取):
- 位置:
设置 → Git → Pull 页面→ 开启开关(紫色)。 - 作用:确保
commit-and-sync操作包含「拉取」步骤,实现双向同步。
- 位置:
3. 辅助设置(保持默认即可)
- Auto commit-and-sync only staged files:保持关闭(默认),自动提交所有修改文件。
- Split timers for automatic commit and sync:保持关闭(默认),使用单一间隔简化配置。
六、验证同步功能
-
测试远程→本地同步:
- 在 GitHub 网页端修改一个笔记(如新增文件或编辑内容)。
- 回到 Obsidian,按
Ctrl + P打开命令面板,输入Git: Pull并执行。 - 观察是否弹出「拉取成功」提示,且本地能显示网页端的修改。
-
测试本地→远程同步:
- 在 Obsidian 中编辑一个笔记,保存后等待
Auto commit-and-sync interval(如 5 分钟)或手动触发(Ctrl + P→Git: Create backup)。 - 刷新 GitHub 网页端,查看是否显示本地修改。
- 在 Obsidian 中编辑一个笔记,保存后等待
七、常见问题排查
-
克隆时提示「Authentication Failed」:
- 若用 HTTPS 地址,确保在终端手动执行
git pull时输入正确的 GitHub 账号密码(或 Personal Access Token)。 - 若用 SSH 地址,确认已配置 SSH 密钥(参考 GitHub SSH 配置指南) 。
- 若用 HTTPS 地址,确保在终端手动执行
-
同步冲突:
- 若本地和远程同时修改同一文件,Git 会提示冲突。解决方法:先在命令面板执行
Git: Commit提交本地更改,再执行Git: Pull拉取远程,手动合并冲突后重新提交。
- 若本地和远程同时修改同一文件,Git 会提示冲突。解决方法:先在命令面板执行
通过以上步骤,即可实现 Obsidian 库从云端下载后,本地与远程的自动双向同步。调整间隔值可平衡同步频率与性能,建议新手从默认值开始,根据使用习惯优化。