一、前置软件、插件
(一)Git及Github账号
(二)Obsidian的Git插件
-
进入设置,点击第三方插件,关闭“安全模式”

-
浏览“社区插件市场”,安装“Git”

-
配置自动推送和拉取(可选)

二、配置步骤
(一)第一次推送
- 在需要同步的vault根目录,配置
.gitignore文件- 打开Obsidian笔记库的根目录(含
.obsidian隐藏文件夹的目录) - 在该目录下,创建名为
.gitignore的新文件(注意文件名前有.,无扩展名) - 用文本编辑器(如记事本、VS Code、Sublime Text等)打开
.gitignore文件 - 复制并粘贴以下内容到
.gitignore文件中# Obsidian specific files .obsidian/workspace.json .obsidian/app.json .obsidian/appearance.json .obsidian/community-plugins.json .obsidian/core-plugins.json .obsidian/plugins/*/data.json .obsidian/workspaces.json .obsidian/backups/ .obsidian/cache/
- 保存并关闭
.gitignore文件
- 打开Obsidian笔记库的根目录(含
- 在Github网页创建远程仓库,注意选择private
- 打开浏览器,访问 GitHub 并登录账号
- 在页面右上角,点击“+”号,然后选择“New repository”(新建仓库)
- Repository name (仓库名称)输入有意义的名称,例如
MyObsidianNotes或KnowledgeBase - Description (描述)(可选) 添加对仓库的简要描述
- Public/Private (公开/私有)务必选择“Private”(私有)个人笔记通常包含敏感信息,不应公开
- Add a README file (添加README文件) 不要勾选 将在本地初始化Git仓库,并手动添加README
- Add .gitignore (添加.gitignore) 不要勾选 已手动创建
.gitignore文件 - Choose a license (选择许可证) 不要勾选
- 点击“Create repository”(创建仓库)按钮
- 创建成功后,GitHub会显示一个页面,其中包含远程仓库的URL(例如
https://github.com/your-username/your-repo-name.git或git@github.com:your-username/your-repo-name.git) 请复制这个URL 后续会用到
- 初始化需要同步的vault,并推送到刚刚建立的远程仓库
- 方法一:直接通过Obsidian Git插件推送:单击
Commit-and-sync图标
- 方法二:如果方法一失败,则在Git Bash命令行推送(注意定位到vault根目录)
* 初始化本地Git仓库
bash git init- 添加所有文件到暂存区
git add . - 提交首次更改
git commit -m "Initial commit for Obsidian vault" - 关联远程仓库(使用SSH)
- 将
YOUR_REMOTE_REPOSITORY_URL替换为在步骤2中从GitHub复制的仓库URLgit remote add origin git@github.com:your-username/your-repo-name.git origin是远程仓库的默认别名
- 将
- 设置主分支名称(GitHub默认使用
main分支)git branch -M main - 推送本地更改到远程仓库
git push -u origin main
- 添加所有文件到暂存区
- 方法一:直接通过Obsidian Git插件推送:单击
(二)后续同步
- 提交更改:同方法一
- 拉取更改:单击Obsidian Git插件的
Pull图标