个人知识管理系统搭建
结合 Obsidian、Vercel 和 GitHub 可以搭建一个强大的个人知识管理系统,并通过静态站点将 Markdown 笔记发布为网页。以下是这种组合的关键步骤和用途:
1. 组合方案概述
- Obsidian: 用于本地化知识管理和笔记记录,支持 Markdown 文件的双向链接和插件扩展。
- GIT:
obsidian的vault需要git额外管理,方便会退(通过MCP用大模型修改会导致错误修改,方便回退) - GitHub: 作为版本控制工具,用于存储 Obsidian 笔记的 Markdown 文件,并与 Vercel 集成。
- Vercel: 静态站点托管服务,用于将 Markdown 文件转换为网页并公开访问。
2. 实现步骤
(1)在本地创建 Obsidian 笔记库
(2)在 GitHub 上创建存储库
-
登录 GitHub,创建一个新的存储库,例如
my-obsidian-site。 -
将本地 Obsidian 笔记库的文件推送到这个存储库:
git init git add . git commit -m "Initial commit" git branch -M main git remote add origin https://github.com/yourusername/my-obsidian-site.git git push -u origin main
(3)选择静态站点生成器
将 Markdown 文件转换为静态网站,可以选择以下生成器:
- Hugo: 快速且支持大量主题,推荐 Hugo Learn Theme。
- Gatsby: React 驱动的现代静态站点生成器,支持 Markdown 转换。
- Docusaurus: Facebook 开发,适合文档型网站。
- MkDocs: 轻量化静态文档生成器,推荐主题 Material for MkDocs。
(4)部署到 Vercel
- 注册并登录 Vercel。
- 在 Vercel 上新建一个项目,选择 GitHub 存储库
my-obsidian-site。 - 配置生成命令和输出目录(根据所选的生成器):
- Hugo:
- Build Command:
hugo - Output Directory:
public
- Build Command:
- MkDocs:
- Build Command:
mkdocs build - Output Directory:
site
- Build Command:
- Hugo:
- 部署后,Vercel 会自动生成一个站点 URL,例如
https://my-obsidian-site.vercel.app。
(5)自动化同步
- 配置 Obsidian Git 插件,定期将笔记同步到 GitHub。
- 每次同步后,Vercel 会自动触发构建和部署,更新网站内容。
3. 示例项目
- Obsidian Publish Alternative: 使用 Hugo 将 Obsidian 笔记发布到 Vercel。
- Gatsby Starter Obsidian: 将 Obsidian 转换为 Gatsby 项目。
4. 整体优势
- 本地知识管理: Obsidian 提供高效的离线笔记体验。
- 版本控制: GitHub 保留所有版本的历史记录。
- 自动化发布: Vercel 实现快速部署和更新。
- 可视化呈现: 网站支持图表、代码高亮等扩展功能,适合知识分享。