Obsidian 插件文档
安装、配置和使用 Obsidian 的 SpeakNotes 插件的完整指南。
安装
下载插件
下载适用于 Obsidian 的最新版本 SpeakNotes 插件。
下载插件在 Obsidian 中安装
- 打开 Obsidian 并转到 设置 → 社区插件
- 如果出现提示，请禁用安全模式
- 点击“从文件安装”或将下载的 zip 文件解压到仓库的 .obsidian/plugins/speaknotes 文件夹中
- 在社区插件列表中启用 SpeakNotes 插件
启用插件
安装后，请确保在社区插件设置中启用该插件。您应该会看到功能栏中出现一个麦克风图标。
入门指南
连接您的 SpeakNotes 账户
- 打开 设置 → SpeakNotes
- 点击“使用 SpeakNotes 登录”
- 在浏览器中登录您的 SpeakNotes 账户
- 插件将自动连接并开始同步
注意： 您需要一个 SpeakNotes 账户才能使用该插件。如果您还没有账户，请在 speaknotes.io 注册。
录制语音备忘录
直接在 Obsidian 中录制语音备忘录。您的录音将自动上传到 SpeakNotes 进行转录和总结。
如何录制
- 点击功能栏中的麦克风图标，或使用命令 'SpeakNotes: Record Voice Memo'
- 点击“开始录制”并对着麦克风说话
- 完成后点击“停止录制”
- 选择标题和总结格式，然后等待处理
录制功能
- 实时波形可视化
- 录制计时器显示
- 从 14 种以上的总结格式中选择（笔记、要点、会议记录等）
同步您的库
让您的 Obsidian 库与 SpeakNotes 库保持同步。您的所有转录和总结都可以导出为 Markdown 文件。
自动同步
在设置中启用“自动同步”，以便在 Obsidian 启动时自动同步。您还可以设置同步间隔，以确保您的库全天保持更新。
手动同步
随时使用命令 'SpeakNotes: Sync SpeakNotes Library' 或点击侧边栏中的同步按钮进行手动同步。
文件夹结构
同步的笔记将保存到您配置的导出文件夹（默认为 'SpeakNotes'）。该插件会在 Obsidian 中保留您的 SpeakNotes 文件夹结构。
可用命令
通过命令面板 (Ctrl/Cmd + P) 访问所有命令。所有命令都以 'SpeakNotes:' 开头。
打开 SpeakNotes 库侧边栏以浏览和搜索您的笔记。
打开录制弹窗以捕获新的语音备忘录。
手动将您的 SpeakNotes 库与您的 Obsidian 库同步。
将当前打开的笔记导出到 SpeakNotes。
一次性将多个笔记从您的库导出到 SpeakNotes。
将笔记从 SpeakNotes 导入到您的库。
扫描 SpeakNotes 笔记并创建指向您库中相关内容的反向链接。
查看 SpeakNotes 笔记之间连接的可视化关系图谱。
设置参考
连接设置
- 已连接账户 - 显示您已连接的 SpeakNotes 账户邮箱。点击“断开连接”以取消关联。
- 上次同步 - 显示库上次同步的时间。点击“立即同步”以触发手动同步。
同步设置
- 导出文件夹 - SpeakNotes 文件在您的库中保存的文件夹。默认为 'SpeakNotes'。
- 自动同步 - 在 Obsidian 启动时自动同步您的库。
- 同步间隔 - 同步频率（以分钟为单位）。设置为 0 以禁用定期同步。默认为 30 分钟。
内容设置
- 默认总结格式 - 用于新录音的默认格式（例如：笔记、要点、会议记录）。
- 包含完整转录 - 是否在导出的笔记中包含完整的转录文本。
- 导出模板 - 导出笔记的自定义 Markdown 模板。留空则使用默认模板。
导出模板
自定义导出到 Obsidian 时 SpeakNotes 的格式。使用模板变量插入笔记数据。
| 变量 | 描述 |
|---|---|
| {{id}} | 笔记的唯一 SpeakNotes ID |
| {{title}} | 笔记标题 |
| {{created}} | 笔记创建日期（ISO 格式） |
| {{updated}} | 笔记最后更新日期（ISO 格式） |
| {{type}} | 内容类型（audio, video, youtube, pdf） |
| {{status}} | 处理状态（Done, Processing, Error） |
| {{format}} | 摘要格式（note, bullet-points, meeting-notes 等） |
| {{isPinned}} | 笔记是否已置顶（true/false） |
| {{summary}} | AI 生成的摘要内容 |
| {{transcription}} | 完整转录文本（如果在设置中启用） |
示例模板
---
speaknotes_id: {{id}}
created: {{created}}
updated: {{updated}}
type: {{type}}
tags: [speaknotes]
---
# {{title}}
## Summary
{{summary}}
## Transcription
{{transcription}}故障排除
插件无法连接到我的账户
请确保您已在浏览器中登录 SpeakNotes。尝试在插件设置中断开并重新连接。检查您的浏览器是否允许来自 speaknotes.io 的弹窗。
笔记未同步
通过检查状态栏确认您已连接。只有状态为“Done”的笔记才会同步。尝试使用命令面板进行手动同步。检查您的导出文件夹是否存在且可写。
录音启动失败
确保您的浏览器/Obsidian 拥有麦克风权限。检查是否有其他应用程序正在使用麦克风。尝试重启 Obsidian。
同步后部分笔记缺失
只有已完成的笔记（状态：Done）会被同步。仍在处理中的笔记将在完成后显示。检查侧边栏中的文件夹过滤器。
仍然有问题？请联系我们： [email protected]