README.md · jarvis/mind-map

<h1 align="center">Simple mind map</h1>

[![npm-version](https://img.shields.io/npm/v/simple-mind-map)](https://www.npmjs.com/package/simple-mind-map)
![npm download](https://img.shields.io/npm/dm/simple-mind-map)
[![GitHub issues](https://img.shields.io/github/issues/wanglin2/mind-map)](https://github.com/wanglin2/mind-map/issues)
![license](https://img.shields.io/npm/l/express.svg)
[![GitHub stars](https://img.shields.io/github/stars/wanglin2/mind-map)](https://github.com/wanglin2/mind-map/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/wanglin2/mind-map)](https://github.com/wanglin2/mind-map/network/members)

> 中文名：思绪思维导图。一个简单&强大的 Web 思维导图。

本项目包含两部分：

1.一个 js 思维导图库，不依赖任何框架，可以使用它来快速完成 Web 思维导图产品的开发。

开发文档：[https://wanglin2.github.io/mind-map-docs/](https://wanglin2.github.io/mind-map-docs/)。

2.一个 Web 思维导图，基于思维导图库、Vue2.x、ElementUI 开发，可以操作电脑本地文件，可以当做一个在线版思维导图应用使用，也可以自部署和二次开发。

在线地址：[https://wanglin2.github.io/mind-map/](https://wanglin2.github.io/mind-map/)。

此外也提供了客户端可供下载使用，支持`Windows`、`Mac`及`Linux`，下载地址：

Github：[releases](https://github.com/wanglin2/mind-map/releases)。百度云盘：[地址](https://pan.baidu.com/s/1huasEbKsGNH2Af68dvWiOg?pwd=3bp3)。

> 客户端版本会落后于在线版本，尝试最新功能请优先使用在线版。

【云存储版本】如果你需要带后端的云存储版本，可以尝试我们开发的另一个项目[理想文档](https://github.com/wanglin2/lx-doc)。

# 特性

- [x] 插件化架构，除核心功能外，其他功能作为插件提供，按需使用，减小打包体积
- [x] 支持逻辑结构图（向左、向右逻辑结构图）、思维导图、组织结构图、目录组织图、时间轴（横向、竖向）、鱼骨图等结构
- [x] 内置多种主题，允许高度自定义样式，支持注册新主题
- [x] 节点内容支持文本（普通文本、富文本）、图片、图标、超链接、备注、标签、概要、数学公式
- [x] 节点支持拖拽（拖拽移动、自由调整）、多种节点形状；支持扩展节点内容、支持使用 DDM 完全自定义节点内容
- [x] 支持画布拖动、缩放
- [x] 支持鼠标按键拖动选择和 Ctrl+左键两种多选节点方式
- [x] 支持导出为`json`、`png`、`svg`、`pdf`、`markdown`、`xmind`、`txt`，支持从`json`、`xmind`、`markdown`导入
- [x] 支持快捷键、前进后退、关联线、搜索替换、小地图、水印、滚动条、手绘风格、彩虹线条、标记、外框
- [x] 提供丰富的配置，满足各种场景各种使用习惯
- [x] 支持协同编辑
- [x] 支持演示模式

官方提供了如下插件，可根据需求按需引入（某个功能不生效大概率是因为你没有引入对应的插件），具体使用方式请查看文档：

> RichText（节点富文本插件）、Select（鼠标多选节点插件）、Drag（节点拖拽插件）、AssociativeLine（关联线插件）、Export（导出插件）、KeyboardNavigation（键盘导航插件）、MiniMap（小地图插件）、Watermark（水印插件）、TouchEvent（移动端触摸事件支持插件）、NodeImgAdjust（拖拽调整节点图片大小插件）、Search（搜索插件）、Painter（节点格式刷插件）、Scrollbar（滚动条插件）、Formula（数学公式插件）、Cooperate（协同编辑插件）、RainbowLines（彩虹线条插件）、Demonstrate（演示模式插件）、OuterFrame（外框插件）、HandDrawnLikeStyle（手绘风格插件）[收费]、Notation（节点标记插件）[收费]、Numbers（节点编号插件）[收费]、Freemind（Freemind格式导入导出插件）[收费]、Excel（Excel格式导入导出插件）[收费]、Checkbox（待办插件）[收费]

本项目不会实现的特性：

> 1.自由节点，即多个根节点；
>
> 2.概要节点后面继续添加节点；
>
> 如果你需要以上特性，那么本库可能无法满足你的需求。

# 安装

```bash
npm i simple-mind-map
```

# 使用

提供一个宽高不为 0 的容器元素：

```html
<div id="mindMapContainer"></div>
```

另外再设置一下`css`样式：

```css
#mindMapContainer * {
  margin: 0;
  padding: 0;
}
```

然后创建一个实例：

```js
import MindMap from "simple-mind-map";

const mindMap = new MindMap({
  el: document.getElementById("mindMapContainer"),
  data: {
    data: {
      text: "根节点",
    },
    children: [],
  },
});
```

即可得到一个思维导图。

想要实现更多功能？可以查看[开发文档](https://wanglin2.github.io/mind-map-docs/)。

# License

# 微信交流群

微信添加`wanglinguanfang`拉你入群。根据过往的经验，大部分问题都可以通过查看issue列表或文档解决，所以提问前请确保你已经阅读完了所有文档，文档里没有的可在群里提问，不必私聊作者。

# star

如果喜欢本项目，欢迎点个 star，这对我们很重要。

[![Star History Chart](https://api.star-history.com/svg?repos=wanglin2/mind-map&type=Date)](https://star-history.com/#wanglin2/mind-map&Date)

# 关于定制

如果你有个性化的商用定制需求，可以联系我们，我们提供付费开发服务，无论前端、后端、还是部署，都可以帮你一站式搞定。

# 请作者喝杯咖啡

开源不易，如果本项目有帮助到你的话，可以考虑请作者喝杯咖啡~

> 推荐使用支付宝，微信获取不到头像。转账请备注【思维导图】。
>
> 也可以通过购买付费插件来支持我们：[付费插件](https://wanglin2.github.io/mind-map-docs/plugins/about.html)。
>
> 为什么需要你的赞助：simple-mind-map 的目标是成为开源中最好的思维导图，为开发者提供一个快速实现思维导图产品的js库，为用户提供一个免费好用的思维导图软件，为了这个目标，作者已经持续开发维护了3年多，耗费了非常多的精力，随着时间的推移，simple-mind-map 已经取得了一定的成绩，相比最初，无论是功能，还是体验都已经有了翻天覆地的改变，但是收益方面却可以忽略不计，因为 simple-mind-map 是采用 MIT 许可的开源项目，永久免费，保留版权下可随意商用，这也意味着很难直接通过项目获取收益，为爱发电的激情总会慢慢消退，所以你的赞助对项目的可持续发展非常重要，是作者持续维护的最大动力。

<img src="./web/src/assets/avatar/Think.jpg" style="width: 50px;height: 50px;" />
 Think
 
 
 <img src="./web/src/assets/avatar/志斌.jpg" style="width: 50px;height: 50px;" />
 志斌
 
 
 <img src="./web/src/assets/avatar/小土渣的宇宙.jpeg" style="width: 50px;height: 50px;" />
 小土渣的宇宙
 
 
 <img src="./web/src/assets/avatar/qp.jpg" style="width: 50px;height: 50px;" />
 qp
 
 
 <img src="./web/src/assets/avatar/ZXR.jpg" style="width: 50px;height: 50px;" />
 ZXR
 
 
 <img src="./web/src/assets/avatar/花儿朵朵.jpg" style="width: 50px;height: 50px;" />
 花儿朵朵
 
 
 <img src="./web/src/assets/avatar/suka.jpg" style="width: 50px;height: 50px;" />
 suka
 
 
 <img src="./web/src/assets/avatar/Chris.jpg" style="width: 50px;height: 50px;" />
 Chris
 
 
 <img src="./web/src/assets/avatar/水车.jpg" style="width: 50px;height: 50px;" />
 水车
 
 
 <img src="./web/src/assets/avatar/仓鼠.jpg" style="width: 50px;height: 50px;" />
 仓鼠
 
 
 <img src="./web/src/assets/avatar/千帆.jpg" style="width: 50px;height: 50px;" />
 千帆
 
 
 <img src="./web/src/assets/avatar/才镇.jpg" style="width: 50px;height: 50px;" />
 才镇
 
 
 <img src="./web/src/assets/avatar/小米.jpg" style="width: 50px;height: 50px;" />
 小米bbᯤ²ᴳ
 
 
 <img src="./web/src/assets/avatar/棐.jpg" style="width: 50px;height: 50px;" />
 *棐
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 Luke
 
 
 <img src="./web/src/assets/avatar/布林.jpg" style="width: 50px;height: 50px;" />
 布林
 
 
 <img src="./web/src/assets/avatar/南风.jpg" style="width: 50px;height: 50px;" />
 南风
 
 
 <img src="./web/src/assets/avatar/蜉蝣撼大叔.jpg" style="width: 50px;height: 50px;" />
 蜉蝣撼大叔
 
 
 <img src="./web/src/assets/avatar/乙.jpg" style="width: 50px;height: 50px;" />
 乙
 
 
 <img src="./web/src/assets/avatar/敏.jpg" style="width: 50px;height: 50px;" />
 敏
 
 
 <img src="./web/src/assets/avatar/沐风牧草.jpg" style="width: 50px;height: 50px;" />
 沐风牧草
 
 
 <img src="./web/src/assets/avatar/有希.jpg" style="width: 50px;height: 50px;" />
 有希
 
 
 <img src="./web/src/assets/avatar/樊笼.jpg" style="width: 50px;height: 50px;" />
 樊笼
 
 
 <img src="./web/src/assets/avatar/达仁科技.jpg" style="width: 50px;height: 50px;" />
 达仁科技
 
 
 <img src="./web/src/assets/avatar/小逗比.png" style="width: 50px;height: 50px;" />
 小逗比
 
 
 <img src="./web/src/assets/avatar/天清如愿.jpg" style="width: 50px;height: 50px;" />
 天清如愿
 
 
 <img src="./web/src/assets/avatar/敬明朗.jpg" style="width: 50px;height: 50px;" />
 敬明朗
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 飞箭
 
 
 <img src="./web/src/assets/avatar/戚永峰.png" style="width: 50px;height: 50px;" />
 戚永峰
 
 
 <img src="./web/src/assets/avatar/moom.jpg" style="width: 50px;height: 50px;" />
 moom
 
 
 <img src="./web/src/assets/avatar/张扬.png" style="width: 50px;height: 50px;" />
 张扬
 
 
 <img src="./web/src/assets/avatar/长沙利奥软件.jpg" style="width: 50px;height: 50px;" />
 长沙利奥软件
 
 
 <img src="./web/src/assets/avatar/HaHN.jpg" style="width: 50px;height: 50px;" />
 HaHN
 
 
 <img src="./web/src/assets/avatar/继龙.jpg" style="width: 50px;height: 50px;" />
 继龙
 
 
 <img src="./web/src/assets/avatar/欣.jpg" style="width: 50px;height: 50px;" />
 欣
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 易空小易
 
 
 <img src="./web/src/assets/avatar/国发.jpg" style="width: 50px;height: 50px;" />
 国发
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 建明
 
 
 <img src="./web/src/assets/avatar/汪津合.jpg" style="width: 50px;height: 50px;" />
 汪津合
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 博文
 
 
 <img src="./web/src/assets/avatar/慕智打印-兰兰.jpg" style="width: 50px;height: 50px;" />
 慕智打印-兰兰
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 锦冰
 
 
 <img src="./web/src/assets/avatar/旭东.png" style="width: 50px;height: 50px;" />
 旭东
 
 
 <img src="./web/src/assets/avatar/俊奇.jpg" style="width: 50px;height: 50px;" />
 俊奇
 
 
 <img src="./web/src/assets/avatar/橘半.jpg" style="width: 50px;height: 50px;" />
 橘半
 
 
 <img src="./web/src/assets/avatar/pluvet.jpg" style="width: 50px;height: 50px;" />
 pluvet
 
 
 <img src="./web/src/assets/avatar/皇登攀.jpg" style="width: 50px;height: 50px;" />
 皇登攀
 
 
 <img src="./web/src/assets/avatar/风格.jpg" style="width: 50px;height: 50px;" />
 风格
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 SR
 
 
 <img src="./web/src/assets/avatar/逆水行舟.jpg" style="width: 50px;height: 50px;" />
 逆水行舟
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 LiuJL
 
 
 <img src="./web/src/assets/avatar/L.jpg" style="width: 50px;height: 50px;" />
 L
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 sunniberg
 
 
 <img src="./web/src/assets/avatar/在下青铜五.jpg" style="width: 50px;height: 50px;" />
 在下青铜五
 
 
 <img src="./web/src/assets/avatar/木星二号.jpg" style="width: 50px;height: 50px;" />
 木星二号
 
 
 <img src="./web/src/assets/avatar/阿晨.jpg" style="width: 50px;height: 50px;" />
 阿晨
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 铁
 
 
 <img src="./web/src/assets/avatar/庆国.jpg" style="width: 50px;height: 50px;" />
 庆国
 
 
 <img src="./web/src/assets/avatar/Alex.jpg" style="width: 50px;height: 50px;" />
 Alex
 
 
 <img src="./web/src/assets/avatar/子豪.jpg" style="width: 50px;height: 50px;" />
 子豪
 
 
 <img src="./web/src/assets/avatar/宏涛.jpg" style="width: 50px;height: 50px;" />
 宏涛
 
 
 <img src="./web/src/assets/avatar/最多5个字.jpg" style="width: 50px;height: 50px;" />
 最多5个字
 
 
 <img src="./web/src/assets/avatar/雨馨.jpg" style="width: 50px;height: 50px;" />
 雨馨
 
 
 <img src="./web/src/assets/avatar/ZX.jpg" style="width: 50px;height: 50px;" />
 ZX
 
 
 <img src="./web/src/assets/avatar/峰.jpg" style="width: 50px;height: 50px;" />
 峰
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 协成
 
 
 <img src="./web/src/assets/avatar/木木.jpg" style="width: 50px;height: 50px;" />
 木木
 
 
 <img src="./web/src/assets/avatar/好名字.jpg" style="width: 50px;height: 50px;" />
 好名字
 
 
 <img src="./web/src/assets/avatar/Kyle.jpg" style="width: 50px;height: 50px;" />
 Kyle
 
 
 <img src="./web/src/assets/avatar/lsytyrt.jpg" style="width: 50px;height: 50px;" />
 lsytyrt
 
 
 <img src="./web/src/assets/avatar/秀树因馨雨.jpg" style="width: 50px;height: 50px;" />
 秀树因馨雨
 
 
 <img src="./web/src/assets/avatar/buddy.jpg" style="width: 50px;height: 50px;" />
 buddy
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 小川
 
 
 <img src="./web/src/assets/avatar/Tobin.jpg" style="width: 50px;height: 50px;" />
 Tobin
 
 
 <img src="./web/src/assets/avatar/夏虫不语冰.jpg" style="width: 50px;height: 50px;" />
 夏虫不语冰
 
 
 <img src="./web/src/assets/avatar/晴空.jpg" style="width: 50px;height: 50px;" />
 晴空
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 黄泳
 
 
 <img src="./web/src/assets/avatar/ccccs.jpg" style="width: 50px;height: 50px;" />
 ccccs
 
 
 <img src="./web/src/assets/avatar/。.png" style="width: 50px;height: 50px;" />
 。
 
 
 <img src="./web/src/assets/avatar/Jeffrey.jpg" style="width: 50px;height: 50px;" />
 Jeffrey
 
 
 <img src="./web/src/assets/avatar/张文建.jpg" style="width: 50px;height: 50px;" />
 张文建
 
 
 <img src="./web/src/assets/avatar/炫.jpg" style="width: 50px;height: 50px;" />
 炫
 
 
 <img src="./web/src/assets/avatar/Lawliet.jpg" style="width: 50px;height: 50px;" />
 Lawliet
 
 
 <img src="./web/src/assets/avatar/一叶孤舟.jpg" style="width: 50px;height: 50px;" />
 一叶孤舟
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 晏江
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 Eric
 
 
 <img src="./web/src/assets/avatar/Joe.jpg" style="width: 50px;height: 50px;" />
 Joe
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 中文网字计划-江夏尧
 
 
 <img src="./web/src/assets/avatar/梁辉.jpg" style="width: 50px;height: 50px;" />
 梁辉
 
 
 <img src="./web/src/assets/avatar/海云.jpg" style="width: 50px;height: 50px;" />
 海云
 
 
 <img src="./web/src/assets/avatar/皮老板.jpg" style="width: 50px;height: 50px;" />
 皮老板
 
 
 <img src="./web/src/assets/avatar/h.r.w.jpg" style="width: 50px;height: 50px;" />
 h.r.w
 
 
 <img src="./web/src/assets/avatar/default.png" style="width: 50px;height: 50px;" />
 Matt
 
 
 <img src="./web/src/assets/avatar/时光匆匆.png" style="width: 50px;height: 50px;" />
 时光匆匆

jarvis/mind-map

简介

发行版

贡献者

近期动态

jarvis/mind-map .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

jarvis/mind-map