Obsidian-Git插件详细配置
Git插件
中英文对照每一个配置+解释和建议
核心概念
工作流:
Stage all changes → Commit → Pull → Push
sync ≈ 先pull + 再push
配置
Automatic(自动提交与同步)
这部分是核心的自动备份设置:
Split timers for automatic commit and sync:开启后,自动【提交commit】 和 【同步sync】可以设置不同的时间间隔(关闭时共用同一个间隔)。
Auto commit-and-sync interval (minutes):设置每隔
X分钟执行自动【提交commit】 和 【同步sync】的操作;设为0(默认值)则禁用该自动功能。当前配置:
1分钟(即每 1 分钟自动提交并同步一次)。Auto commit-and-sync after stopping file edits:要求上一个配置项「Auto commit-and-sync interval」不能为
0。开启后,会在停止编辑文件X分钟后自动【提交commit】 和 【同步sync】(编辑文件时不会触发,避免冲突);关闭则完全按固定时间间隔执行,与文件编辑状态无关。==我自己现在还是在typora编辑,所以这个我还是不开启最舒服==Auto commit-and-sync after latest commit:开启后,会把 “最后一次自动提交同步的时间戳” 更新为 “最近一次提交(含手动提交)的时间戳”,从而减少手动提交后自动执行的频率(避免短时间内重复提交)。通俗解释是 “手动提交后,自动备份的闹钟会重置”。)
Auto push interval (minutes):设置每隔
X分钟自动推送本地提交到远程仓库;设为0(默认值)则禁用自动【推送push】,依赖「commit-and-sync」流程处理。Auto pull interval (minutes):设置每隔
X分钟自动从远程仓库拉取最新变更;设为0(默认值)则禁用自动【拉取pull】。Auto commit-and-sync only staged files:关闭。自动提交会包含所有修改过的文件,无需手动暂存。(开启:自动提交「仅手动暂存的文件」,需要手动选文件)
Specify custom commit message on auto commit-and-sync:关闭。自动提交使用预设消息(下一个配置),不会弹出输入框。(开启后自动提交时会弹出输入框让你写自定义提交信息)
Commit message on auto commit-and-sync:自动提交的预设消息。预设为
vault backup: {{date}},用日期作为备份标识。
| 配置项 | 中文解释 | 建议 |
|---|---|---|
| Split timers for automatic commit and sync | 分离定时器:开启后,自动【提交】和【同步】可设置不同时间间隔 | 按需开启 |
| Auto commit-and-sync interval | 每隔 X 分钟自动执行提交+同步;设为 0 禁用 |
单设备 30-60 分钟,多设备 5-10 分钟 |
| Auto commit-and-sync after stopping file edits | 停止编辑 X 分钟后自动提交同步(编辑时不触发,避免冲突) | ✅ 强烈建议开启 |
| Auto commit-and-sync after latest commit | 手动提交后重置自动备份计时器,避免短时间内重复提交 | ✅ 建议开启 避免手动提交后立即触发自动提交 |
| Auto push interval | 自动推送间隔(分钟),0 表示不单独自动推送 |
使用 commit-and-sync 即可 |
| Auto pull interval | 自动拉取间隔(分钟),0 表示不自动拉取 |
多设备建议设置 5-10 分钟 |
| Auto commit-and-sync only staged files | 仅自动提交已手动暂存的文件 | 关闭 = 自动提交所有变更 ✅ |
| Specify custom commit message on auto commit-and-sync | 自动提交时弹出输入框自定义提交信息 | 关闭 = 使用预设模板 ✅ |
| Commit message on auto commit-and-sync | 自动提交的预设消息模板 | 可自定义 |
Commit message(提交信息)
这部分控制提交记录的格式:
Commit message on manual commit:手动提交时的预设消息,当前也是
vault backup: {{date}}。可用占位符:{{date}}(日期)、{{hostname}}(设备名)、{{numFiles}}(变更文件数量)、{{files}}(变更文件名)。Commit message script:空,不启用。通过
sh -c执行一段脚本,自动生成提交信息,可以结合 AI 工具(如 ChatGPT)来生成规范的 commit message。可用占位符:
{{hostname}}、{{date}}。1763878912000 placeholder format:
定义提交信息中
{{date}}占位符的日期格式,基于 Moment.js 的语法。当前配置:YYYY-MM-DD HH:mm:ss,这会生成类似2025-10-08 15:30:00这样的日期格式。List filenames affected by commit in the commit body:关闭。提交信息里不会列出具体改动的文件名。
| 配置项 | 中文解释 | 当前配置 |
|---|---|---|
| Commit message on manual commit | 手动提交时的预设消息 | vault backup: {{date}} |
| Commit message script | 通过脚本自动生成提交信息(可接 AI) | 空(未启用) |
| 1763878912000 placeholder format | 日期格式(Moment.js 语法) | YYYY-MM-DD HH:mm:ss |
| List filenames affected by commit in the commit body | 提交信息正文中列出变更的文件名 | 关闭 |
Pull(拉取设置)
==建议都开启==
这部分控制从远程仓库拉取更改的行为:
- Merge strategy:设为
Merge。拉取远程更改时用合并方式,保留提交历史。 - Pull on startup:开启。Obsidian 启动时会自动拉取远程仓库的最新更改,确保本地笔记是最新的。
| 配置项 | 中文解释 | 建议 |
|---|---|---|
| Merge strategy | 合并策略:Merge(合并)或 Rebase(变基) |
✅ 建议 Merge,保留完整历史 |
| Pull on startup | Obsidian 启动时自动拉取远程最新更改 | ✅ 多设备必开,防止冲突 |
Commit-and-sync(提交同步流程)
这是插件的核心工作流,默认是「暂存所有→提交→拉取→推送」:
- Push on commit-and-sync:执行 “提交并同步” 时,是否自动推送本地提交到远程仓库。开启后,同步会包含 “推送” 步骤;关闭则只执行「提交 + 拉取」,不推送,适合你想先验证本地变更再手动推送的场景。
- Pull on commit-and-sync:执行 “提交并同步” 时,是否先拉取远程的最新变更。开启后,同步会先拉取远程变更,确保本地和远程一致,减少冲突。
| 配置项 | 中文解释 | 建议 |
|---|---|---|
| Push on commit-and-sync | 执行同步时自动推送到远程 | ✅ 开启,确保备份到云端 |
| Pull on commit-and-sync | 执行同步时先拉取远程变更 | ✅ 必开,先同步再推送,减少冲突 |
**Line author information **
- Show commit authoring information next to each line:关闭。不在编辑器每行旁显示作者、提交哈希等信息,保持界面简洁。
| 配置项 | 中文解释 | 建议 |
|---|---|---|
| Show commit authoring information next to each line | 在每行代码旁显示作者、提交哈希等信息 | 关闭 ✅,保持界面简洁,减少性能开销 |
History view
- Show Author:设为
Hide。历史视图里不显示提交作者。 - Show Date:开启。历史视图里显示提交日期,使用你设置的
{{date}}格式。
Source control view(源码控制视图)
Automatically refresh source control view on file changes
开关已开启:文件内容变化时,自动刷新 Git 源码控制视图。提示在性能较差的设备上可能卡顿,可关闭此选项。
Source control view refresh interval
刷新间隔,700 毫秒,文件变化后等待多久刷新。避免频繁刷新影响性能。
| 配置项 | 中文解释 | 建议 |
|---|---|---|
| Automatically refresh source control view on file changes | 文件变更时自动刷新 Git 面板 | 性能差设备建议关闭 |
| Source control view refresh interval | 刷新间隔(毫秒) | 性能差设备建议增大到 2000+ |
Miscellaneous(杂项设置)
- Diff view style
差异视图样式,当前是 “Split”(分栏)模式。说明说 Split 模式的 diff 是编辑器生成的,不是 Git,好处是可以在视图里编辑文本。 - 通知相关开关
Disable informative notifications:禁用信息性通知(Git 操作的通知)。(避免打扰)Disable error notifications:禁用所有错误通知,当前为关闭状态。Hide notifications for no changes:当没有需要提交 / 推送的变更时,隐藏通知,当前为关闭状态。
- 界面集成开关
Show status bar:开启状态栏显示,需重启 Obsidian 生效。File menu integration:开启后,在文件菜单中添加 “暂存”“取消暂存”“添加到 .gitignore” 等 Git 操作选项。Show branch status bar:开启分支状态栏显示,需重启生效。Show the count of modified files in the status bar:在状态栏显示修改文件数量,当前为关闭状态。
| 配置项 | 中文解释 | 当前配置 | 建议 |
|---|---|---|---|
| Diff view style | 差异视图样式:Split(分栏)或 Unified(统一) |
Split |
Split 支持在 diff 中直接编辑 |
| Disable informative notifications | 禁用 Git 操作的通知 | 关闭 | 按需,==避免打扰可开启== |
| Disable error notifications | 禁用错误通知 | 关闭 | 建议保持关闭,及时发现问题 |
| Hide notifications for no changes | 无变更时隐藏通知 | 关闭 | 开启可减少无意义通知 |
| Show status bar | 显示 Git 状态栏 | 开启 | ✅ 建议开启 |
| File menu integration | 右键文件菜单添加 Git 操作 | 开启 | ✅ 建议开启,操作便捷 |
| Show branch status bar | 状态栏显示当前分支 | 开启 | 需重启生效 |
| Show the count of modified files in the status bar | 状态栏显示修改文件数量 | 关闭 | 按需开启 |
Commit author(提交作者信息)
Author name for commit
Author email for commit
这两个输入框用于设置 Git 提交时的作者名和邮箱,当前为空,需要你手动填写。
Advanced(高级设置)
Update submodules
控制是否在 “提交同步” 或 “拉取” 时更新 Git 子模块,说明中提到该功能还有缺失(如冲突文件处理、提交计数等)。
路径与环境变量
Custom Git binary path:自定义 Git 可执行文件的路径,默认值为git(系统默认路径)。Additional environment variables:添加额外的环境变量(格式为KEY=VALUE,每行一个),示例为GIT_DIR=/path/to/git/dir。Additional PATH environment variable paths:添加额外的系统 PATH 路径,每行一个。Reload with new environment variables:点击 “Reload” 按钮,用新的环境变量重新加载插件;提示移除旧环境变量需要重启 Obsidian。
仓库路径自定义
Custom base path (Git repository path):设置 Git 仓库相对于 Obsidian Vault 的路径(适用于仓库不在 Vault 根目录的场景)。Custom Git directory path (Instead of '.git'):自定义 Git 元数据目录的路径(替代默认的.git目录),需重启生效。
Disable on this device:在当前设备禁用该插件,设置不会同步到其他设备,当前为关闭状态。
Support(支持与调试)
- Donate:提供 “Buy me a coffee” 捐赠按钮,支持插件开发者。
- Copy Debug Information:复制调试信息,用于排查问题。
- Debugging and logging:提示你可以用快捷键
Ctrl + Shift + I打开控制台,查看插件的日志信息。

