Obsidian + GitHub + MacBook 完整设置指南:打造跨设备知识库
Obsidian + GitHub + MacBook 完整设置指南:打造跨设备知识库
📚 为什么选择 Obsidian + GitHub?
Obsidian 是一款强大的知识管理工具,通过 Markdown 文件构建你的个人知识库。结合 GitHub 进行版本控制和跨设备同步,你可以:
– ✅ 在多设备间无缝同步笔记
– ✅ 享受完整的版本历史和回滚功能
– ✅ 离线工作,随时同步
– ✅ 与 AI 助手(如 OpenClaw)无缝集成
– ✅ 免费且安全(私有仓库)
🎯 本指南涵盖
1. 在 MacBook 上安装 Obsidian
2. 创建 GitHub 私有仓库
3. 配置 SSH 密钥
4. 设置 Git 同步
5. 配置 Obsidian Git 插件
6. 测试跨设备同步
—
📋 前置要求
– MacBook(macOS)
– GitHub 账户
– 基本的命令行操作能力
– (可选)VPS 或其他设备用于测试跨设备同步
—
第一步:安装 Obsidian
方法 1:Homebrew 安装(推荐)
brew install --cask obsidian
方法 2:直接下载
1. 访问 https://obsidian.md/download
2. 下载 macOS 版本
3. 打开 .dmg 文件
4. 将 Obsidian 拖拽到 Applications 文件夹
5. 从 Applications 启动
—
第二步:创建 GitHub 仓库
1. 登录 GitHub
访问 https://github.com 并登录你的账户。
2. 创建新仓库
1. 点击右上角的 “+” → “New repository”
2. Repository name: obsidian-vault(或你喜欢的名称)
3. Description: Obsidian vault for personal knowledge base
4. Visibility: 选择 Private(私有)🔒
5. 重要: 不要勾选 “Initialize this repository with a README”
6. 点击 “Create repository”
3. 复制仓库 URL
创建后,你会看到类似这样的 URL:
https://github.com/yourusername/obsidian-vault.git
或 SSH URL:
git@github.com:yourusername/obsidian-vault.git
复制这个 URL,稍后会用到。
—
第三步:配置 SSH 密钥
为什么需要 SSH 密钥?
SSH 密钥让你的 MacBook 可以安全地与 GitHub 通信,无需每次输入密码。
1. 检查是否已有 SSH 密钥
ls -la ~/.ssh/
如果你看到 id_ed25519 或 id_rsa 文件,说明已有密钥。如果没有,继续下一步。
2. 生成新的 SSH 密钥
ssh-keygen -t ed25519 -C "your.email@example.com" -f ~/.ssh/id_ed25519_github -N ""
参数说明:
– -t ed25519: 使用 ED25519 算法(更安全、更快)
– -C: 添加注释(通常是你的邮箱)
– -f: 指定密钥文件名
– -N "": 不设置密码(方便自动同步)
3. 添加 SSH 密钥到 SSH 代理
# 启动 SSH 代理
eval "$(ssh-agent -s)"
# 添加密钥
ssh-add ~/.ssh/id_ed25519_github
4. 显示公钥
cat ~/.ssh/id_ed25519_github.pub
你会看到类似这样的输出:
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIBRCAQXG6Lf2fV2KNJpqZR7VJ5XyoEhlShxeZB7DqxR1 your.email@example.com
复制这一整行(从 ssh-ed25519 开始到结尾)。
5. 添加 SSH 密钥到 GitHub
1. 访问 https://github.com/settings/keys
2. 点击 “New SSH key”
3. Title: MacBook Pro(或任何你喜欢的名称)
4. Key type: 选择 Authentication key(不是 Signing key)
5. Key: 粘贴刚才复制的公钥
6. 点击 “Add SSH key”
6. 测试 SSH 连接
ssh -T git@github.com
如果看到这样的消息,说明配置成功:
Hi yourusername! You've successfully authenticated, but GitHub does not provide shell access.
—
第四步:克隆 GitHub 仓库
1. 选择克隆位置
cd ~
这会将仓库克隆到你的用户主目录。
2. 克隆仓库
使用 SSH URL(推荐):
git clone git@github.com:yourusername/obsidian-vault.git ObsidianVault
或使用 HTTPS URL:
git clone https://github.com/yourusername/obsidian-vault.git ObsidianVault
3. 进入仓库目录
cd ObsidianVault
4. 配置 Git 用户信息(首次使用)
git config user.name "Your Name"
git config user.email "your.email@example.com"
—
第五步:初始化 Obsidian Vault
1. 创建基本文件夹结构
mkdir -p "Daily Notes" Projects Memory Inbox Templates
2. 创建初始文件
创建 README.md
cat > README.md << 'EOF'
# Obsidian Vault
This is my personal knowledge base powered by Obsidian and GitHub.
## 📁 Folder Structure
- **Daily Notes/** - Daily journal entries
- **Projects/** - Active projects
- **Memory/** - Long-term knowledge
- **Inbox/** - Quick capture
- **Templates/** - Note templates
## 🔄 Sync
This vault is synced via GitHub. Changes are automatically pushed and pulled.
## 🤖 AI Integration
This vault works with OpenClaw AI assistant for automated note management.
EOF
创建 index.md(主页)
cat > index.md << 'EOF'
---
cssclass: dashboard
---
# My Knowledge Base
## 📋 Quick Links
- [[Daily Notes]] - Journal entries
- [[Projects]] - Active projects
- [[Memory]] - Long-term knowledge
## 📝 Recent Notes
TABLE file.mtime as "Last Modified"
FROM ""
WHERE file.mtime >= date(today) - dur(7 days)
SORT file.mtime DESC
LIMIT 10
## 🎯 Today's Focus
-
## 📚 Resources
- [Obsidian Help](https://help.obsidian.md)
- [GitHub Repository](https://github.com/yourusername/obsidian-vault)
EOF
创建每日笔记模板
mkdir -p Templates
cat > "Templates/Daily Note.md" << 'EOF'
---
date: {{date}}
tags: [daily-note]
---
# {{date}}
## 📋 Today's Focus
-
## ✅ Completed
-
## 🔄 In Progress
-
## 📝 Notes
-
## 💡 Ideas
-
EOF
创建项目模板
cat > "Templates/Project.md" << 'EOF'
---
created: {{date}}
status: active
tags: [project]
---
# {{title}}
## 🎯 Goal
-
## 📋 Tasks
- [ ] Task 1
- [ ] Task 2
- [ ] Task 3
## 📝 Notes
-
## 🔗 Resources
-
## 📊 Progress
- Started: {{date}}
- Status: Active
- Last updated: {{date}}
EOF
3. 提交初始文件
git add .
git commit -m "Initial commit: Obsidian vault setup"
git push -u origin main
---
第六步:在 Obsidian 中打开 Vault
1. 启动 Obsidian
从 Applications 启动 Obsidian。
2. 打开 Vault
1. 点击 "Open folder as vault"
2. 导航到 ~/ObsidianVault
3. 点击 "Open"
3. 探索你的 Vault
你会看到:
- index.md - 你的主页
- README.md - 说明文档
- Templates/ - 模板文件夹
- Daily Notes/ - 每日笔记文件夹
- Projects/ - 项目文件夹
- Memory/ - 知识库文件夹
- Inbox/ - 收件箱文件夹
---
第七步:配置 Obsidian Git 插件
1. 启用社区插件
1. 点击左下角的 设置 图标(齿轮)
2. 点击 Community plugins
3. 关闭 Safe mode(如果开启)
4. 点击 Browse 搜索插件
2. 安装 Obsidian Git 插件
1. 在插件市场搜索 "Obsidian Git"
2. 点击 Install
3. 安装完成后,点击 Enable
3. 配置自动备份
在 Settings → Obsidian Git 中配置:
自动备份设置
- Auto backup: ✅ 启用
- Auto backup interval: 15 分钟
- Auto backup after changes: 5 个文件
提交信息
- Auto commit message: Auto commit: {{date}} {{time}}
拉取/推送设置
- Auto pull before backup: ✅ 启用
- Auto push after backup: ✅ 启用
分支设置
- Current branch: main
4. 测试插件
1. 点击左侧边栏的 Git 图标
2. 点击 Create backup(或按 Cmd+P,输入 "Git: Create backup")
3. 你应该看到:
- 检测到更改
- 创建提交
- 推送到远程
---
第八步:测试跨设备同步
1. 在 MacBook 上创建测试笔记
1. 在 Obsidian 中创建新笔记(Cmd+N)
2. 输入内容:
# Test Note
This is a test note from my MacBook!
Created: 2026-04-06
Testing the Obsidian + GitHub sync.
3. 重命名为 Test Note
4. 等待 15 分钟(或手动触发备份)
2. 验证同步
在 MacBook 上:
cd ~/ObsidianVault
git status
你应该看到 Test Note.md 已被提交。
在 GitHub 上:
访问你的仓库,你应该看到 Test Note.md 文件。
3. 在其他设备上拉取
如果你有其他设备(如 VPS),可以拉取更改:
cd /path/to/obsidian-vault
git pull origin main
---
第九步:与 AI 助手集成(可选)
如果你使用 OpenClaw 或其他 AI 助手,可以让它帮你管理笔记:
读取笔记
Read my index.md file
创建笔记
Create a daily note for today
更新笔记
Add "Tested Obsidian integration" to my daily note
搜索笔记
Find all notes tagged with #project
组织笔记
Move all notes tagged with #archive to the Memory folder
---
🎯 最佳实践
1. 定期提交
即使配置了自动备份,也要定期手动提交重要更改:
cd ~/ObsidianVault
git add .
git commit -m "Update: description of changes"
git push origin main
2. 使用有意义的提交信息
避免使用 "update" 或 "fix" 这样的模糊信息。使用描述性的信息:
git commit -m "Add project notes for Obsidian setup guide"
3. 定期备份
虽然 GitHub 很可靠,但定期备份到其他位置(如本地硬盘或云存储)是个好习惯。
4. 使用标签
在 Obsidian 中使用标签来组织笔记:
# Project Note
Tags: #project #active #obsidian
5. 创建模板
为不同类型的笔记创建模板,保持一致性。
---
🔧 故障排除
问题 1:SSH 连接失败
错误信息:
Permission denied (publickey)
解决方案:
1. 检查 SSH 密钥是否已添加到 GitHub
2. 确认使用的是正确的 SSH 密钥
3. 测试连接:ssh -T git@github.com
问题 2:推送失败
错误信息:
error: failed to push some refs to 'github.com'
解决方案:
git pull origin main
git push origin main
问题 3:Obsidian Git 插件不工作
解决方案:
1. 确认 Git 已安装:git --version
2. 检查插件设置
3. 查看插件日志
问题 4:合并冲突
解决方案:
git pull origin main
# 手动解决冲突
git add .
git commit -m "Resolve merge conflict"
git push origin main
---
📚 进阶技巧
1. 使用 Git 分支
为实验性内容创建分支:
git checkout -b experiment
# 做一些实验
git add .
git commit -m "Experiment: try new layout"
git checkout main
2. 使用 Git Hooks
创建自动化的 Git hooks:
# 创建 pre-commit hook
cat > .git/hooks/pre-commit << 'EOF'
#!/bin/bash
# 在提交前运行检查
echo "Running pre-commit checks..."
EOF
chmod +x .git/hooks/pre-commit
3. 使用 GitHub Actions
设置自动化工作流:
# .github/workflows/backup.yml
name: Backup
on: [push]
jobs:
backup:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
---
🎉 总结
通过本指南,你已经成功:
✅ 安装了 Obsidian
✅ 创建了 GitHub 私有仓库
✅ 配置了 SSH 密钥
✅ 设置了 Git 同步
✅ 配置了 Obsidian Git 插件
✅ 测试了跨设备同步
现在你拥有了一个强大的、跨设备的知识管理系统!
📖 相关资源
- [Obsidian 官方文档](https://help.obsidian.md)
- [GitHub 官方文档](https://docs.github.com)
- [Git 官方文档](https://git-scm.com/doc)
- [Obsidian Git 插件文档](https://github.com/Vinzent03/obsidian-git)
---
祝你使用愉快! 🚀
如果你在设置过程中遇到任何问题,欢迎在评论区留言或联系我。
