obsidian使用github同步踩坑教程【补充】

最新推荐文章于 2025-03-30 10:34:30 发布

咋学都不累zgc

最新推荐文章于 2025-03-30 10:34:30 发布

阅读量3.3k

点赞数 27

文章标签： github

本文链接：https://blog.csdn.net/m0_46392159/article/details/141997315

版权

本文由简悦 SimpRead 转码，原文地址 blog.csdn.net

在该作者基础上做了一些补充：

创建 .gitignore文件时，win中使用cmd命令：ren t.txt .gitignore (先手动创建t.txt文件)
建议在obsidian仓库里面进行 git init 防止 git add . 把不需要的文件添加进来。
现有笔记 push 到远程仓库命令修改为：

git init 
git add .
git commit -m "first commit" 
git branch -M main
git remote add origin git@github.com:xxx/testgit.git     #这里替换成自己的仓库
git push -u origin main

.gitattributes文件推荐配置

.obsidian/
#.obsidian/plugins
#.obsidian/workspace.json
#.obsidian/workspace-mobile.json
.trash/
.DS_Store

.gitignore文件推荐配置

* text=auto

*.md text
*.txt text
*.js text
*.json text
*.html text
*.css text

*.png binary
*.jpg binary
*.gif binary
*.bmp binary

配置来源：https://fissionneutron.com/post/e532958c/#%E5%90%8C%E6%AD%A5-obsidian-%E5%BA%93

前言

本文主要介绍了 obsidian 使用 git 插件进行多端同步的方法，远程仓库为 github，如果觉得 github 网络不稳定，也可以使用国内的 gitee。

什么是 obsidian

Obsidian 是一款功能强大的笔记应用程序，它支持使用 Markdown 语法创建和组织笔记。它依靠双链功能可以很容易的建立笔记间的关联。优点是笔记可以本地离线保存，打开速度非常快，不用担心服务器数据丢失。缺点是多端数据同步功能需要收费，不过也可以根据网上的方法实现免费同步，本文使用 obsidian 的 git 插件实现多端同步。

Obsidian 下载

官网下载，然后根据平台选择版本下载，建议使用迅雷下载，浏览器可能下载不下来。
官网：https://obsidian.md/download
安卓版：https://wwdx.lanzoue.com/b030yr97g

git 软件准备

git 安装
Git 安装 - 廖雪峰博客
git 配置
git config --global user.name “用户名”
git config --global user.email “你的邮箱”
生成密钥
ssh-keygen -t rsa -C "你的邮箱"

根据上图红线路径，复制公钥 id_rsa.pub
将公钥粘贴到 GitHub
注册 github 账号，登录 GitHub，点击右上角用户头像图标，点击 Settings，进入设置页面
Settings 页面点击 “SSH and GPG keys”，然后点击右上角 “New SSH key”，添加 ssh key
Title 填入名称，key 填入复制的 id_rsa.pub 内容，然后点击 “Add SSH key”

创建 github 仓库

登录 github，创建私有仓库
选择 SSH，记住自己的仓库. git 结尾的那个：

obsidian 安装 git 插件

为了实现 Obsidian 与 GitHub 的同步，还需要安装 Obsidian Git 插件。这个插件能够自动将本地保存的笔记文件推送（push）到 GitHub 仓库，并在每次打开 Obsidian 时自动从 GitHub 仓库中拉取（pull）最新的文件。

打开 obsidian，点击 “设置”-“文件与链接”-“第三方插件”，关闭“安全模式”，点击“社区插件” 的“浏览”，搜索 “Obsidian Git” 然后安装

也可以通过链接下载，下载后放到. obsidian/plugins 目录下，没有 plugins 创建
git 插件：链接: https://pan.baidu.com/s/1RkiMgTb28TF6FcejTUpnpg 提取码: nvbt
将你现有笔记 push 到远程仓库
在你的笔记目录，Windows 右键选择 open git bash here，linux 直接执行命令。

假设你的笔记仓库名为 obdocs

git init 
git add obdocs
git commit -m "first commit" 
git remote add origin git@github.com:xxx/testgit.git     #这里替换成自己的仓库
git push -u origin main

启动插件
配置插件实现文件自动 commit 和 push 到仓库

以下配置表示每隔 2 分钟会 commit 和 push，每次 5 分钟会自动 pull 最新版本。
以下配置表示，软件启动会自动 pull 最新版本。

配置. gitignore 文件
在自己的笔记目录下创建. gitignore 文件，注意.gitignore 文件一定要包含 .obsidian/workspace.json 文件，同时最好不要有 50M 以上的大文件，避免引起麻烦。或者也可以将 .obsidian 加入. gitignore 文件。

将 .obsidian 加入. gitignore 文件可以写成：
/.obsidian/

其他终端同步

其他终端先使用 git clone 拉取分支，然后就可以编辑笔记了，最好不要多个终端同时操作，会造成冲突。
git clone git@github.com:xxx/testgit.git