Obsidian Clipper Sync 插件安装教程

从零开始,5 分钟完成插件安装与配置

开始前的准备

  • 在电脑上安装 Obsidian 软件
  • 创建至少一个 Obsidian 笔记库(Vault)
  • 打开「文章剪藏同步助手」微信小程序,获取 API Key

第一步:下载并安装插件

  1. 下载 obsidian-clipper-sync.zip,解压得到 obsidian-clipper-sync/ 文件夹,内含 main.jsmanifest.json
  2. 在 Obsidian 笔记库的 .obsidian/plugins/ 目录下创建 obsidian-clipper-sync/ 文件夹。
  3. 将解压后的两个文件放入该文件夹中,最终路径应为:
    .obsidian/plugins/obsidian-clipper-sync/main.js
  4. 重启 Obsidian,确保插件能被正常识别。
常见错误:文件夹层级不对
  • ❌ 错误:把 main.js 直接放到 plugins/ 下,没有套文件夹
  • ❌ 错误:多套了一层文件夹,变成 plugins/obsidian-clipper-sync/obsidian-clipper-sync/main.js
  • ✅ 正确:plugins/obsidian-clipper-sync/main.js

第二步:在 Obsidian 中启用插件

  1. 打开 Obsidian,点击左下角的设置图标(⚙️ 齿轮)。
  2. 在左侧菜单中向下滚动,找到「第三方插件」并点击。
  3. 关闭「安全模式」开关。
  4. 继续向下滚动,找到「已安装插件」,应能看到「Obsidian Clipper Sync」,点击右侧灰色开关将其打开。

第三步:配置 API Key 与同步目录

  1. 打开微信,搜索「文章剪藏同步助手」小程序,进入底部菜单「获取 API Key」。
    文章剪藏同步助手微信小程序码,微信扫码即可使用

    微信扫码体验小程序

  2. 在设置页面点击「复制 API Key」。
  3. 回到 Obsidian,点击「Obsidian Clipper Sync」插件的 ⚙️ 设置按钮。
  4. 将 API Key 粘贴到输入框中,点击「验证」确认 API Key 有效。
  5. 验证通过后,选择用于存放同步文章的「同步目录」。
  6. 可选:开启「自动同步」,按设定间隔自动拉取新文章。

第四步:开始使用

  1. 在微信小程序中粘贴公众号文章链接,点击抓取,文章会自动保存到云端。
  2. 回到 Obsidian,点击左侧工具栏的同步按钮,或按 Ctrl+P 打开命令面板,搜索「Obsidian Clipper Sync」。
  3. 选择「同步剪藏文章」只同步新文章,或「全量重新同步」将所有文章同步到 Obsidian。
  4. 同步成功后,文章会以 Markdown 格式出现在你指定的同步目录中。

常见问题

插件安装后看不到?

请检查 .obsidian/plugins/obsidian-clipper-sync/ 文件夹下是否直接包含 main.jsmanifest.json,不要多一层或少一层文件夹。

API Key 验证失败?

请确认从小程序设置页复制的 API Key 完整无误,注意区分大小写和前后空格。验证前先确保小程序中已成功获取 API Key。

同步后没有文章出现?

请确认:1) 小程序中已成功抓取文章;2) API Key 已验证通过;3) 同步目录已选择;4) 已点击同步按钮或开启自动同步。

如何更新插件?

重新下载最新版本的 main.jsmanifest.json,替换 .obsidian/plugins/obsidian-clipper-sync/ 文件夹中的旧文件,然后重启 Obsidian。