README file from
GithubMindmap Xmind
A plugin to view and interactively edit XMind mind maps (.xmind format) inside Obsidian.
- Plugin ID:
mindmap-xmind - Version:
1.0.8 - Minimum Obsidian version:
1.4.0 - Supports desktop and mobile (not desktop-only)
在 Obsidian 中查看与交互编辑 XMind 思维导图(.xmind 格式)的插件。
- 插件 ID:
mindmap-xmind - 版本:
1.0.8 - 最低 Obsidian 版本:
1.4.0 - 支持桌面端、移动端(非桌面独占)
功能特性
- 打开 .xmind 文件:直接点击库中的
.xmind文件即可在 Obsidian 内以思维导图视图打开。 - 交互编辑:选中节点后增删主题、折叠/展开分支、双击编辑文字。
- 新建思维导图:从命令面板,或在文件列表右键菜单「新建思维导图」——右键文件夹会在该文件夹内创建,右键文件会在其所在目录创建。
- 工具栏图标化:所有操作以图标按钮呈现,悬停显示功能名称;当窗口空间不足时,多余按钮自动收入「更多」下拉,空间充足则全部平铺。
- 缩略图(mini map):右下角缩略图,可在设置中开关,工具栏按钮可临时切换。
- 自动保存:编辑内容可按设定间隔自动落盘,无需手动保存。
安装
方式一:手动安装(开发者)
- 下载本仓库,将以下文件放到你的 vault 的插件目录
你的仓库/.obsidian/plugins/mindmap-xmind/下:main.jsmanifest.jsonstyles.css
- 在 Obsidian 中打开 设置 → 第三方插件,关闭「安全模式」,启用 Mindmap Xmind。
方式二:从源码构建
# 安装依赖(使用项目内置的 node 环境即可)
npm install
# 开发模式(带 watch,文件变更自动重新打包)
node esbuild.config.mjs
# 生产构建
node esbuild.config.mjs production
构建产物 main.js 会生成在插件根目录。
使用说明
打开 / 新建
- 打开:在文件列表中点击任意
.xmind文件。 - 新建(命令面板):命令面板搜索「新建思维导图」,输入文件名即可。
- 新建(右键):在文件列表的文件夹或文件上右键 → 「新建思维导图」,将在对应目录创建
.xmind文件。
编辑快捷键
| 操作 | 快捷键 |
|---|---|
| 手动保存 | Ctrl/Cmd + S |
| 添加子主题 | Tab |
| 添加同级主题 | Enter |
| 删除节点 | Delete |
| 折叠 / 展开分支 | 空格 |
| 编辑节点文字 | 双击节点 |
工具栏
工具栏以图标按钮提供常用操作(悬停显示名称):
- 适应视图、保存
- 添加子主题、添加同级、删除、折叠/展开
- 更多(导出 SVG / 导出 PNG / 缩略图 / 打开面板)
当视窗宽度不足以平铺全部按钮时,末尾的按钮会自动收纳进「更多」下拉,始终保持至少一个按钮可见。
设置
在 Obsidian 设置 → Mindmap Xmind 中可配置:
| 设置项 | 说明 |
|---|---|
| 自动保存 | 编辑时按间隔自动保存,无需手动点击保存 |
| 自动保存间隔 | 自动保存的时间间隔(秒),范围 10–300,默认 30 |
| 默认布局 | 新建导图时使用的默认布局 |
| 紧凑模式 | 新建导图默认使用紧凑布局(间距更小);已有文件以自身设置为准 |
| 主题配色 | 新建导图分支配色:经典 / 彩虹分支 / 柔和色板;已有文件以自身设置为准 |
| 显示缩略图 | 打开导图时是否默认显示右下角缩略图(默认关闭,工具栏按钮可临时切换) |
| 默认缩放 | 打开导图时的初始缩放:适应视图(自动)或 100%(原始大小) |
项目结构
mindmap-xmind/
├── main.js # 构建产物(ESM 打包)
├── manifest.json # 插件元信息
├── styles.css # 样式
├── esbuild.config.mjs # 构建脚本
├── src/
│ ├── main.ts # 插件入口:命令、右键菜单、设置面板
│ ├── MindMapView.ts # 思维导图视图:工具栏、画布、交互
│ ├── model.ts # 节点 / 导图数据模型
│ ├── xmind.ts # .xmind 文件读写解析
│ ├── markers.ts # 标记(图标)支持
│ └── util.ts # 工具函数
└── sample-*.xmind # 示例导图(功能/鱼骨图/组织架构/标记 等)
许可证
本插件以 MIT 许可证 发布,版权归作者所有。完整条款见仓库根目录的 LICENSE 文件。
第三方依赖
- JSZip(MIT 许可证):用于在浏览器中解析与生成
.xmind(ZIP 格式)文件,已随本插件一并打包分发,遵守其原始许可证。