安装
💡TL;DR
从 Obsidian 社区插件安装 Notemd,或把同一个 GitHub Release 的三个插件文件复制到 Vault。启用后配置 provider,再用一篇可丢弃的笔记试运行。模型服务与可选原生导出工具有各自的前置条件。
方法一:社区插件(推荐)
- 在目标 Vault 打开 设置 → 第三方插件。
- 按需启用第三方插件,选择浏览。
- 搜索 Notemd,确认仓库为
Jacobinwwey/obsidian-NotEMD,然后安装。 - 启用插件,通过侧栏图标或命令面板打开 Notemd。
在 Obsidian 中打开 Notemd。浏览器无法打开该链接时,按上述步骤操作;阅读本指南不需要自定义协议处理程序。
方法二:手动安装
前置条件
准备已安装的 Obsidian 和能够备份的 Vault。manifest 声明最低版本为 0.15.0,这不代表当前候选版本已经在该旧版本上验证。
操作步骤
- 打开 GitHub Releases,从同一个版本下载
main.js、manifest.json和styles.css。发布包还附带README.md,供查阅,无须安装到运行目录。 - 创建
<vault>/.obsidian/plugins/notemd/并复制这三个文件。.obsidian是默认配置目录;若 Vault 使用了其他配置目录,应采用实际路径。 - 重载 Obsidian,在第三方插件设置中启用 Notemd。
- 核对显示的插件版本,再配置 provider。不要混用新 manifest 和旧 bundle。
可选方案:通过 BRAT 安装
已有 BRAT 的用户可通过其测试插件流程添加 Jacobinwwey/obsidian-NotEMD。复现问题时明确指定版本。BRAT 是可选外部工具,不是常规安装的依赖。
验证
在 Notemd 设置中选择可访问的 provider/model,运行 Test Connection(测试连接),再按快速开始处理笔记副本。有些连接测试只能证明模型列表端点可用;实际任务才能验证生成与文件输出。
系统要求
| 范围 | 边界 |
|---|---|
| 插件 manifest | 最低 Obsidian 版本声明为 0.15.0;isDesktopOnly 为 false |
| 验证证据 | 查阅当前版本的带日期验收记录;尚未验证实体移动设备和 Obsidian 0.15.0 |
| 托管 LLM | 网络、有效账户或密钥、可用模型 |
| 本地 LLM | 单独安装并运行的服务,以及已下载或加载的模型 |
| 原生幻灯片/电路导出 | 桌面工具和格式特定依赖;运行前检查导出环境 |
不存在覆盖所有可选导出器的统一操作系统版本保证。插件内电路预览不等于原生 TeX 编译成功,桌面验证也不能证明移动端行为。
卸载
在第三方插件中停用或卸载 Notemd。生成的笔记和产物仍是普通 Vault 文件,删除前应逐一核对。如需重装,先备份插件设置。卸载不会回滚已经完成的笔记修改。
更新
在第三方插件中检查更新并升级。手动更新前停止活动任务,备份 Vault 与设置,用同一版本的三个运行文件替换旧文件,然后重载。阅读版本说明,完成小规模试运行后再恢复批量处理。
不要用 Release 附件替换 Vault 设置文件。需要回退时,保留备份并明确选择已知兼容版本,同时保留需要的输出。
后续阅读
- 快速开始:配置并核对首次任务。
- 配置:provider、语言和输出。
- 故障排查:启动、连接和导出失败。
- GitHub Issues:提交可复现的安装问题。