OpenPlug 让没有 VPN 的用户也能一键安装 Obsidian 官方社区插件和主题:点击官方社区的 “Add to Obsidian”,OpenPlug 即经国内 GitHub 镜像加速完成下载、校验与安装。
安装
- 官方社区商店(推荐):Obsidian → 设置 → 第三方插件 → 关闭安全模式 → 浏览社区插件 → 搜索 OpenPlug → 安装并启用。
- 手动安装:从 GitHub Releases 下载
main.js、manifest.json、styles.css三个文件,放入 vault 下的.obsidian/plugins/openplug/目录(移动端为对应应用文件夹内的同一路径),重启 Obsidian 后在第三方插件列表中启用。也可用 BRAT 插件添加jiaoyingxing/openplug跟踪预发布版本。
使用方式
两种入口,任选其一:
- 官方社区路径(推荐)
- 打开 Obsidian 官方社区,浏览并找到需要的插件或主题。
- 进入详情页,点击 Add to Obsidian。
- 在 Obsidian 中同意跳转,自动回到 OpenPlug 面板完成安装。
- 面板内直接搜索
- 点击左侧边栏的购物车图标,或通过命令面板执行「打开插件 / 主题安装器」。
- 在搜索框输入插件名、主题名或作者名,从结果中选择并安装。
安装时会先展示插件信息卡(版本 / 作者 / ID / 兼容性)与简介译文,可自选安装版本;确认后一键下载、校验、安装并启用。
主要功能
| 功能 | 说明 |
|---|---|
| 协议接管安装 | 接管官网 Add to Obsidian 的跳转(插件与主题),在国内网络下完成原本连不上的安装链路 |
| 官方清单搜索 | 基于官方插件 / 主题清单,支持按名称、作者、ID 搜索,中文界面 |
| 信息卡与翻译 | 展示版本、作者、ID、兼容性;插件简介自动中英互译(失败时回退原文,不阻塞安装) |
| 版本自选 | 显示插件历史版本,默认安装最新版,也可回退指定版本 |
| 多镜像竞速加速 | 多个国内 GitHub 加速镜像并发竞速 + 30 秒超时 + 多镜像 SHA256 交叉校验,单个节点失效自动换源 |
| 主题安装 | 与插件相同的路径安装官方主题 |
| 电脑与手机 | Windows / macOS / Linux 与 iOS / Android 均可使用 |
| 镜像测速 | 设置页一键重新测速,直观了解各镜像当前延迟 |
网络使用与隐私披露
运行时只发起以下 HTTPS 请求,全部用于获取公开数据:
- 官方清单:
community-plugins.json与community-css-themes.json(用于搜索与跳转解析)。 - 国内 GitHub 加速镜像(内置并经过实测验证):
gh-proxy.com、ghfast.top、wget.la、gh.idayer.com—— 用于下载清单、manifest 与插件文件。 - jsDelivr 数据接口(
data.jsdelivr.com):获取插件历史版本列表。 - 翻译接口(仅发送公开的插件描述文本,用于侧栏简介的中英互译):
uapis.cn(主源)、api.mymemory.translated.net(兜底)。
不收集任何用户数据,无遥测,无广告,无账号要求。
使用须知与限制
- 本插件不是 Obsidian 官方功能,而是一个获取渠道的辅助工具;安装的插件 / 主题内容均由各自原作者提供,请自行核对来源与权限。
- 仅支持官方社区已上架的插件与主题;不在官方清单中的条目无法安装。
- 镜像节点为公益服务,可用性与速度会随网络环境波动;如遇全部节点不可用,可在设置页重新测速后重试。
- 软件著作权与许可:本插件以 MIT License 开源;安装的第三方插件 / 主题遵循其各自的许可证。
兼容性
- 最低 Obsidian 版本:
1.7.2。 - 桌面与移动端均支持(
isDesktopOnly: false)。
开发
npm run lint # ESLint(obsidianmd 推荐规则)
npm run build # 类型检查 + 生产构建(输出 dist/release)
源码使用 TypeScript,仅依赖 Obsidian API 与 Web API(crypto.subtle 做 SHA256 校验,不使用 Node API),产物由 esbuild 打包。
欢迎提交 Issue、PR 或参与翻译。LICENSE 见 LICENSE。