首页 / 博客 / 教程

笔记同步助手 Obsidian 插件安装教程

教程 作者：笔记同步助手
Obsidian安装教程新手指南

笔记同步助手 Obsidian 插件安装教程

欢迎！ 这个教程将一步步指导您安装笔记同步助手插件。

不用担心！ 即使您对电脑操作不太熟悉，只要按照步骤操作，就能成功安装。整个过程大约需要 10-15 分钟。

开始前的准备

请确保您已经：

  • ✅ 在电脑上安装了 Obsidian 软件
  • ✅ 创建了至少一个 Obsidian 笔记库（保管库）
  • ✅ 关注了”笔记同步助手”微信公众号

基础概念说明

什么是插件？ 插件是为 Obsidian 添加新功能的小程序，就像手机应用一样，可以让软件做更多事情。

什么是 API 密钥？ API 密钥就像一把钥匙，让插件能够安全地连接到笔记同步助手的服务器获取您的数据。

什么是保管库（库）？ 保管库是您在 Obsidian 中存储所有笔记的文件夹，相当于您的”笔记本”。

安装步骤

第一步：获取插件文件

  1. 打开微信，找到”笔记同步助手”公众号
  2. 发送消息”Obsidian”
  3. 您会收到下载链接和 API 密钥（请保存好 API 密钥，稍后需要用到）
  4. 点击链接下载压缩包（文件名类似：obsidian-notehelper-2.1.0.zip）
  5. 在电脑上找到下载的压缩包，右键选择”解压”或”提取”
  6. 解压后会得到一个文件夹（如：2.1.0）

第二步：找到插件安装位置

找到您的插件文件夹：

  1. 打开 Obsidian
  2. 点击左下角的设置图标（⚙️ 齿轮状图标）
  3. 在设置页面左侧，向下滚动找到”关于”选项，点击它
  4. 找到”保管库路径”这一行，复制这个路径
    • 💡 提示：这就是您笔记库的位置
  5. 打开文件管理器（Windows 按 Win+E，Mac 按 Cmd+空格 输入”Finder”）
  6. 在地址栏粘贴刚才复制的路径，按回车前往
  7. 您应该能看到一个名为 .obsidian 的文件夹
    • ❌ 如果看不到：按 Ctrl+H（Windows）或 Cmd+Shift+.（Mac）显示隐藏文件夹
  8. 双击进入 .obsidian 文件夹
  9. 查看是否有 plugins 文件夹
    • ✅ 如果有：双击进入
    • ❌ 如果没有：右键空白处，新建文件夹，命名为 plugins，然后进入

第三步：安装插件文件

  1. 将第一步准备好的文件夹复制到 plugins 文件夹中
  2. 复制完成后，文件夹结构应该是这样：
.obsidian/
├── plugins/
    └── obsidian-notehelper-xx.xx.xx/
        ├── main.js
        ├── manifest.json
        ├── styles.css
        └── 其他文件...

第四步：在 Obsidian 中启用插件

  1. 回到 Obsidian（如果关闭了就重新打开）
  2. 点击左下角的设置图标（⚙️）
  3. 在左侧菜单中，向下滚动找到”第三方插件”，点击它
    • 💡 提示：这个选项在”核心插件”下方
  4. 您会看到一个”安全模式”的开关，点击关闭它
    • ✅ 确认：开关应该变成灰色，显示”已关闭”
    • 💡 说明：关闭安全模式才能使用第三方插件
  5. 向下滚动到”已安装插件”部分
  6. 您应该能看到”笔记同步助手”插件
    • ❌ 如果看不到：请返回检查插件文件是否正确放置，或者重启 Obsidian
  7. 点击插件名称右侧的开关启用插件
    • ✅ 确认：开关变为蓝色，显示插件已启用

第五步：配置 API 密钥

  1. 在”已安装插件”列表中，点击”笔记同步助手”右侧的齿轮图标⚙️进入插件设置
  2. 找到”API Key”输入框
  3. 将第一步获取的 API 密钥粘贴到这个框中
  4. 点击”保存”或直接关闭设置页面（会自动保存）

第六步：测试同步

  1. 在 Obsidian 工具栏，找到笔记同步助手的图标（“同”字图标），点击它
  2. 或者按 Ctrl/Cmd + P 打开命令面板，输入”同步”找到相关命令
  3. 首次同步可能需要几分钟时间
  4. 同步完成后，您应该能在笔记库中看到新创建的”笔记同步助手”文件夹

成功确认

如果看到以下情况，说明安装成功：

  • ✅ 插件在”已安装插件”列表中显示为”已启用”
  • ✅ Obsidian 工具栏出现笔记同步助手图标（“同”字图标）
  • ✅ 点击同步后能够看到同步进度
  • ✅ 笔记库中出现”笔记同步助手”文件夹

遇到问题怎么办？

常见问题解决

Q: 找不到 .obsidian 文件夹 A: 按 Ctrl+H（Windows）或 Cmd+Shift+.（Mac）显示隐藏文件夹

Q: 插件没有出现在列表中 A:

  1. 检查文件夹名是否为”notehelper”
  2. 检查是否放在正确的 plugins 文件夹中
  3. 重启 Obsidian

Q: API 密钥验证失败 A:

  1. 检查密钥是否完整复制（没有多余空格）
  2. 重新向公众号发送”Obsidian”获取新密钥

Q: 同步没有反应 A:

  1. 检查网络连接
  2. 确认 API 密钥配置正确
  3. 查看是否有错误提示

Q: 想要清空内容重新同步怎么办？ A:

  1. 进入插件设置页面
  2. 找到”最后同步时间”或”Sync At”字段
  3. 清空该字段中的内容
  4. 保存设置后重新点击同步
  5. 插件将重新同步所有内容

详细功能说明

插件简介

笔记同步助手能够帮助您将保存的文章和笔记自动同步到 Obsidian 中，支持自定义模板、文件夹结构和同步频率。

配置教程

API 密钥配置

  1. 在插件设置页面找到”API Key”选项
  2. 联系笔记同步助手获取您的专属 API 密钥
  3. 将 API 密钥填入对应字段并保存

文件夹配置

插件会自动在您的 Obsidian 库中创建以下目录结构：

  • 主文件夹：笔记同步助手/{{{date}}}

    • 按日期组织的文章存储目录
    • 日期格式：yyyy-MM-dd
    • 如果不想按日期分类：可以修改为 笔记同步助手 （删除 /{{{date}}} 部分）

  • 附件文件夹：笔记同步助手/attachments

    • 存储文章中的图片和附件

文件夹路径自定义

您可以在插件设置中修改文件夹路径：

  • 按日期分类：笔记同步助手/{{{date}}} （默认）
  • 不分类统一存放：笔记同步助手
  • 其他自定义路径：如 我的文章 或 导入内容/{{{date}}}

💡 提示：{{{date}}} 是日期变量，会自动替换为当天日期（如：2024-01-15）

文件命名规则

  • 文件名格式：{{{title}}}
  • 日期格式：yyyy-MM-dd
  • 文件名会自动处理特殊字符，确保兼容性

同步设置

同步频率

  • 可设置自动同步间隔（分钟）
  • 设置为 0 表示仅手动同步
  • 推荐设置：60 分钟

同步过滤器

  • 全部同步：同步所有项目
  • 仅同步库中项目：只同步已保存的文章
  • 仅同步已归档项目：只同步归档内容

使用方法

手动同步

  1. 点击 Obsidian 左侧工具栏的笔记同步助手图标
  2. 或使用快捷键 Ctrl/Cmd + P 打开命令面板
  3. 搜索”笔记同步助手”相关命令并执行

自动同步

  1. 在插件设置中启用”启动时同步”
  2. 设置合适的同步频率
  3. 插件将按设定频率自动执行同步

查看同步状态

  • 同步进行时，插件图标会显示同步状态
  • 在插件设置页面可查看最后同步时间
  • 如遇问题，可查看 Obsidian 控制台日志

模板自定义

插件支持自定义文章模板，您可以：

  1. 在设置中找到”模板”选项
  2. 修改默认模板以符合您的笔记习惯
  3. 使用变量如 {{{title}}}、{{{author}}}、{{{date_saved}}} 等

可用模板变量

  • title - 文章标题
  • author - 作者
  • date_saved - 保存日期
  • date_published - 发布日期
  • site_name - 来源网站
  • original_url - 原文链接
  • description - 文章描述
  • tags - 标签
  • omnivore_url - 同步助手链接

常见问题

Q: 插件无法正常同步怎么办？

A: 请检查：

  1. API 密钥是否正确配置
  2. 网络连接是否正常
  3. 是否有足够的存储空间

Q: 如何修改文件存储位置？

A: 在插件设置的”文件夹”选项中修改路径，支持使用日期变量。

Q: 可以导入历史数据吗？

A: 插件支持导入历史保存的文章，首次同步可能需要较长时间。

技术支持

如需技术支持，请：

  1. 关注微信公众号”笔记同步助手”
  2. 发送消息”客服”
  3. 收到回复后发送”人工”转接人工客服
  4. 向客服详细描述您遇到的问题

更新日志

当前版本：v2.1.0

  • 优化同步性能
  • 改进日志系统
  • 修复若干已知问题
  • 增强稳定性

感谢使用笔记同步助手！如果您觉得插件有用，欢迎推荐给更多朋友使用。

← 返回博客列表