Skip to content
Obsidian集成 Github存储文档

Obsidian集成Github存储文档

1. GitHub 上创建私有仓库

  • 登录 GitHub → 右上角 +New repository
  • 填写:
    • Repository name:blog(随便起名,小写)
    • Description:可选
    • Visibility:选 Private(私有)
    • 不要勾选:Add a README file、.gitignore、License
  • Create repository
  • 页面会显示仓库地址,复制 SSH 地址(推荐免密):
git@github.com:你的用户名/blog.git

2. 本地 Obsidian 库初始化为 Git 仓库

终端进入你的 Obsidian 库目录,执行:

# 初始化本地 git
git init

# 关联远程私有仓库(用你自己的 SSH 地址)
git remote add origin git@github.com:你的用户名/blog.git

3. 安装 Obsidian Git 插件

  • 打开 Obsidian → 左下角 设置 ⚙️第三方插件
  • 关闭安全模式(必须)
  • 浏览 → 搜索 Git → 安装并启用 Git(作者 Vinzent)
  • 配置全部保持默认即可
  • 安装后点击左侧sidebar上的Git图标打开右侧视图

4. 配置 .gitignore(避免同步垃圾文件)

  • 在左侧Obsidian的文件列表,选中文件夹或文件,右键菜单中选择Git: Add to .ignore
  • 有个隐藏的.obsidian文件夹,其内容是否忽略需要特殊处理
    • 可以同步
      • 插件配置(你装了什么插件、设置是什么)
      • 主题配置
      • 快捷键设置
      • 外观配置
    • 不需要同步的
      • 缓存
      • 工作区布局(每次打开都会变,同步必冲突)
      • 历史记录
      • 临时文件
    • 但这个文件夹无法在Obsidian的文件列表看到,所以手动修改.gitignore文件
# Obsidian 工作区与缓存(必忽略)
.obsidian/workspace
.obsidian/workspace.json
.obsidian/workspace-mobile.json
.obsidian/cache
.obsidian/OfflineSearch
.trash/

# 系统垃圾
.DS_Store
Thumbs.db

# 日志与临时文件
*.log
*.tmp
*.bak

5. 手动测试一次(确保没问题)

  1. 右侧 Git 面板 → Stage相关文件 → 输入备注 → Commit-and-sync
  2. 打开的对话框中输入main,然后提交
  3. 打开 GitHub 私有库,能看到文件已经上传

如果报错,有个小技巧:

  • Ctrl+Shift+I(Win) / Cmd+Opt+I(Mac)可以调出DevTools来看具体错误

如果是upstream branch不对的问题:

  • 按 Ctrl/Cmd+P 搜:Git: Set upstream branch
  • 弹出列表选:origin/main (这一步就是告诉 Git:本地 master 以后就推到远程 main

如果还是解决不了,则直接按如下操作

  • 进入你的 Obsidian 库文件夹,右键 → Git Bash Here
  • 执行如下命令
git branch -m main
git push -u origin main
git config push.default simple