Obsidian

手机端安装笔记同步助手插件

笔记同步助手 · ·Obsidian 教程
Obsidian手机端插件市场安装教程BRAT

手机端安装笔记同步助手插件

本教程将指导你在手机端 Obsidian 中安装「笔记同步助手」插件(插件市场内名称为 Biji Tongbu)。

推荐使用下面的社区插件市场安装方式,全程在 Obsidian 内完成、不需要任何额外工具。如果你的网络无法访问插件市场,可以展开文末的「备选方式:通过 BRAT 安装」。


第一部分:通过社区插件市场安装(推荐)

步骤 1:打开侧边栏

打开 Obsidian,点击左上角的侧边栏图标(方框形按钮),展开左侧面板。

点击左上角侧边栏图标


步骤 2:进入设置

在展开的左侧面板中,点击右下角的齿轮(⚙ 设置)图标,进入设置页面。

点击右下角齿轮图标进入设置


步骤 3:打开第三方插件

在设置页的「选项」列表中向下滑动,点击最下方的 第三方插件

点击「第三方插件」


步骤 4:关闭安全模式

首次使用第三方插件时,会显示一个安全说明页。阅读后点击底部的紫色按钮 关闭安全模式,即可启用第三方插件功能。

如果你之前已经关闭过安全模式,不会出现这一页,直接看下一步即可。

点击底部紫色按钮「关闭安全模式」


步骤 5:进入插件市场

回到第三方插件页面,在「社区插件市场」一栏点击紫色的 浏览 按钮,进入插件市场。

点击「浏览」进入插件市场


步骤 6:搜索插件

在顶部搜索框中输入 biji,在搜索结果中点击 Biji Tongbu(作者:beijing-bijitongbu)进入详情页。

注意选择 Biji Tongbu,不要点成同作者的其它插件。

搜索 biji 并点击 Biji Tongbu


步骤 7:安装

在 Biji Tongbu 详情页中,点击紫色的 安装 按钮。

点击「安装」


步骤 8:启用

安装完成后,页面顶部会提示「成功安装插件 “Biji Tongbu”」。接着点击紫色的 启用 按钮。

安装成功后点击「启用」

启用成功后,按钮区会变成「快捷键 / 禁用 / 卸载」等选项,说明插件已经开始运行。

插件已启用


第二部分:配置密钥

步骤 9:进入插件设置

点击左上角的返回箭头回到设置页,向下滑动到「第三方插件」分组,点击 Biji Tongbu 进入插件设置。

在设置页第三方插件分组中点击 Biji Tongbu


步骤 10:填写密钥

密钥 输入框中输入你的密钥。

密钥获取方式:关注《笔记同步助手》公众号获取

在密钥输入框中填入密钥


第三部分:执行同步

步骤 11:运行同步命令

回到笔记页面,点击右上角的三个点(⋯)菜单,在弹出的菜单中找到底部的 tongbuzhushou(同步助手) 命令并点击。

右上角菜单中点击 tongbuzhushou


步骤 12:等待同步完成

点击同步命令后,会显示 正在获取数据… 的提示,请耐心等待。

正在同步

同步完成后,会显示成功提示,例如:

同步完成!成功处理 2 篇文章

同步完成

同步的文章会保存到你的 Obsidian 仓库中,你可以在文件列表中看到新增的笔记文件。

同步后的文件列表


备选方式:通过 BRAT 安装

如果你的网络无法打开插件市场、或市场中搜索不到插件,可以改用 BRAT 安装。点击下方标题展开完整步骤。

展开 BRAT 安装完整步骤(共 10 步)

第一步:打开设置

打开 Obsidian,点击右下角菜单,进入 Settings(设置)。在设置页面中,向下滑动找到 Community plugins(社区插件) 选项并点击进入。

设置页面

第二步:开启社区插件

首次使用社区插件时,Obsidian 会显示安全提示。点击底部紫色按钮 Turn on community plugins(开启社区插件) 以启用社区插件功能。

开启社区插件

第三步:浏览社区插件

开启后,你会看到社区插件管理页面,点击 Browse(浏览) 按钮进入插件市场。

社区插件已开启

第四步:搜索 BRAT

在插件市场搜索框中输入 brat,找到 BRAT 插件(作者:TfTHacker),点击进入详情页。

搜索 BRAT

第五步:安装 BRAT

在 BRAT 详情页,点击 Install(安装) 按钮。安装完成后,页面顶部会显示 “Successfully installed plugin BRAT” 提示,然后点击 Enable(启用) 按钮启用插件。

安装成功,点击启用

第六步:确认 BRAT 已启用

启用后,页面会显示 Options(选项) 按钮,说明 BRAT 已成功启用。点击 Options 进入 BRAT 设置页面。

BRAT 已启用

第七步:进入 BRAT 设置

在 BRAT 设置页面中,向下滑动找到 Add beta plugin(添加测试版插件) 按钮。

BRAT 设置页

第八步:添加插件地址

点击 Add beta plugin 按钮后,在弹出的对话框中输入笔记同步助手的 GitHub 仓库地址:

https://github.com/notesynchelper/obsidian-notehelper

勾选 Enable after installing the plugin(安装后自动启用),然后点击紫色按钮开始安装。

输入插件地址

第九步:确认安装成功

安装完成后,页面顶部会显示成功提示:

BRAT notesynchelper/obsidian-notehelper (version: latest) The plugin has been registered with BRAT.

这表示笔记同步助手插件已成功安装并注册。

插件注册成功

第十步:查看已安装插件

返回社区插件列表,可以看到已安装的 BRATWechat Note Helper(笔记同步助手) 两个插件,且开关都已开启(紫色)。

已安装插件列表

至此 BRAT 方式安装完成。后续配置密钥与执行同步的操作与上文第二、三部分完全相同(BRAT 装出来的插件在设置页中名为 Wechat Note Helper,点它进入设置填密钥即可)。

常见问题:GitHub API 限流错误

如果遇到如下错误提示,说明 GitHub API 请求次数超出限制:

API 限流错误

解决方法: 等待一段时间后重试,或者配置 GitHub Token 以提高 API 调用限额。


关键信息汇总

项目内容
推荐安装方式插件市场搜索 biji → 安装 Biji Tongbu(作者:beijing-bijitongbu)
密钥获取方式关注《笔记同步助手》公众号
同步命令右上角 ⋯ 菜单 → tongbuzhushou
备选方式(BRAT)插件地址https://github.com/notesynchelper/obsidian-notehelper

恭喜你完成安装!现在可以开始把内容同步整理到 Obsidian 了。