文档

下载 Obsidian 插件

客户可以从 GitHub Releases 下载打包好的 Obsidian 插件：

也可以直接从本站下载：下载 canvas-workbench-obsidian-plugin.zip

在 Obsidian 中安装

1. 从最新 Release 下载 canvas-workbench-obsidian-plugin.zip。
2. 打开你的 Obsidian vault 文件夹。
3. 如果没有插件目录，创建：<你的 Vault>/.obsidian/plugins/canvas-workbench/

把 zip 内容直接解压到这个目录里。最终结构应该是：

注意：不是把 dist-obsidian 文件夹整个放进去，而是把里面的文件放到 canvas-workbench/ 目录下。

4. 重启 Obsidian，或者关闭再开启第三方插件。
5. 进入 设置 → 第三方插件，找到 Canvas Workbench 并启用。
6. 通过左侧 W 图标或命令面板里的 Canvas Workbench 打开工作台。

主要功能

• 便利贴卡片
• 待办卡片，支持 To-do / Doing / Done 看板列
• 日历卡片，支持月视图和周视图
• 日程 / 事件管理
• 图片、视频、PDF 媒体卡片
• 卡片拖拽、缩放、编辑、最小化和删除确认
• 左侧边栏可收起 / 展开
• 默认本地持久化
• 默认免登录本地模式
• Obsidian 原生插件构建
• 保留本地 API 和 API Key 接口，方便未来扩展 CLI / AI 联动

是否需要启动后端服务？

不需要。

作为 Obsidian 插件使用时，Canvas Workbench 会直接在 Obsidian 内运行，不需要启动：

npm run dev
npm run api:dev
canvas-workbench start

这些命令只用于开发、浏览器版本、或者未来 CLI/API 联动场景。

浏览器 / CLI 快速启动

开发或浏览器版本使用：

npm install
canvas-workbench start

如果你想手动分别启动前端和 API：

npm run api:dev
npm run dev

CLI 命令

• canvas-workbench start — 启动 Web + API
• canvas-workbench start --no-open — 启动但不自动打开浏览器
• canvas-workbench status — 查看运行状态
• canvas-workbench update — 在线更新
• canvas-workbench stop — 停止服务

开发命令

npm install
npm run build
npm run build:obsidian
npm run lint
npm run icons:generate

构建 Obsidian 插件

npm run build:obsidian
cp manifest.json dist-obsidian/manifest.json

产物在 dist-obsidian/。

打包 Obsidian 插件 zip

npm run build:obsidian
cp manifest.json dist-obsidian/manifest.json
mkdir -p release
cd dist-obsidian
zip -r ../release/canvas-workbench-obsidian-plugin.zip .

更多文档

• English README
• API 参考