## File: README.md
Simple mind map
[](https://www.npmjs.com/package/simple-mind-map)
[](https://github.com/wanglin2/mind-map/issues)
[](https://github.com/wanglin2/mind-map/stargazers)
[](https://github.com/wanglin2/mind-map/network/members)
[English](./README_EN.md) | 中文
> 中文名：思绪思维导图。一个简单&强大的 Web 思维导图库和思维导图软件。
本项目包含两部分：开源的JavaScript库和闭源的客户端软件。
# 库、Web
> 即本仓库中的代码，目前已进入低维护状态。
- 一个 `js` 思维导图库，不依赖任何框架，可以用来快速完成 Web 思维导图产品的开发。
> 开发文档：[https://wanglin2.github.io/mind-map-docs/](https://wanglin2.github.io/mind-map-docs/)
- 一个 Web 思维导图，基于思维导图库、`Vue2.x`、`ElementUI` 开发，支持操作电脑本地文件，可以当做一个在线版思维导图应用使用，也可以自部署和二次开发。
> 在线地址：[https://web.sxmind.cn/](https://web.sxmind.cn/)
了解更多信息：[README](./README_MORE_ZH.md)。
# 客户端、插件
> 客户端和插件代码不开源，正在积极开发维护中。
产品官网：[https://sxmind.cn/](https://sxmind.cn/)
## 思绪思维导图客户端
本地化存储，隐私优先，数据安全，软件无需联网即可使用！
- [x] 1.支持创建无限数量的文件、节点（自由节点）；支持创建使用模板；
- [x] 2.提供丰富的设置：基础设置、自定义字体/快捷键/右键菜单/图标、图床配置、AI配置、webdav云同步配置等等，可玩性很高；
- [x] 3.支持思维导图、逻辑结构图、目录组织图、组织结构图、时间轴、鱼骨图、表格等多种结构类型；
- [x] 4.内置上百个丰富好看的主题，也支持自定义主题及AI生成主题；
- [x] 5.节点支持添加文本、图片、链接、图标、备注、附件、标签、概要节点、关联线、外框、标记、待办、描述、编号、数学公式等丰富内容；
- [x] 6.支持导入XMind、FreeMind、Markdown、Txt、Xlsx等格式文件；支持导出为PNG、XMind、SVG、PDF、Markdown、Txt、Xlsx、FreeMind、Mermaid、Html等格式；
- [x] 7.丰富的样式设置：文字、边框、背景、形状、线条、内外边距、图片标签布局等等；
- [x] 8.支持历史版本管理、演示模式、AI生成、手绘风格、大纲编辑、水印、滚动条、同级节点对齐、小地图、进入指定节点、彩虹线条、节点双向链接、搜索替换等等实用有趣的功能；
支持Windows、Mac及Linux系统；支持中文简体、繁體中文、English、Tiếng Việt、Русский、日本語、한국어、Deutsch、Français、Português语言。
下载地址：[Github](https://github.com/wanglin2/mind-map/releases)、[百度网盘](https://pan.baidu.com/s/1C8phEJ5pagAAa-o1tU42Uw?pwd=jqfb)、[夸克网盘](https://pan.quark.cn/s/2733982f1976)、[微软应用商店](https://apps.microsoft.com/detail/9p58vg94khcq?hl=zh-CN&gl=CN)
> 如果在macOS上安装后无法打开，报错**不受信任**或者**移到垃圾箱**，执行下面命令后再启动即可：
> ``` shell
> sudo xattr -d com.apple.quarantine /Applications/思绪思维导图.app
> ```
## Obsidian插件
下载地址：[Github](https://github.com/wanglin2/obsidian-simplemindmap/releases)
## UTools插件
已上架[uTools](https://www.u.tools/)插件应用市场，可直接在`uTools`插件应用市场中搜索`思绪`进行安装，也可以直接访问该地址：[主页](https://www.u-tools.cn/plugins/detail/%E6%80%9D%E7%BB%AA%E6%80%9D%E7%BB%B4%E5%AF%BC%E5%9B%BE/)，点击右侧的【启动】按钮进行安装。
---
## File: simple-mind-map/README.md
# 一个web思维导图的简单实现
详细文档见：[https://github.com/wanglin2/mind-map](https://github.com/wanglin2/mind-map)
---
## File: README_EN.md
Simple mind map
[](https://www.npmjs.com/package/simple-mind-map)
[](https://github.com/wanglin2/mind-map/issues)
[](https://github.com/wanglin2/mind-map/stargazers)
[](https://github.com/wanglin2/mind-map/network/members)
English | [中文](./README.md)
> Chinese name: 思绪思维导图. A simple & powerful web mind map library and mind map software.
This project consists of two parts: an open-source JavaScript library and closed-source client software.
# Library, Web
> Refers to the code in this repository, currently in low-maintenance status.
- A `js` mind map library, independent of any framework, which can be used to quickly develop web-based mind map products.
> Documentation: [https://wanglin2.github.io/mind-map-docs/](https://wanglin2.github.io/mind-map-docs/)
- A web-based mind map application, developed using the mind map library, `Vue2.x`, and `ElementUI`. It supports operations on local computer files, can be used as an online mind map application, and is open for self-deployment and secondary development.
> Online address: [https://web.sxmind.cn/](https://web.sxmind.cn/)
Learn more: [README](./README_MORE_EN.md).
# Client, Plugins
> The client and plugin code are not open source and are under active development and maintenance.
Product official website: [https://sxmind.cn/](https://sxmind.cn/)
- 思绪思维导图 Client
Local storage, privacy-first, data security. The software can be used without an internet connection!
- [x] 1. Supports creating unlimited files and nodes (free nodes); supports creating and using templates.
- [x] 2. Offers rich settings: basic settings, custom fonts/shortcuts/right-click menus/icons, image hosting configuration, AI configuration, WebDAV cloud sync configuration, etc., highly customizable.
- [x] 3. Supports various structure types: mind maps, logical structure diagrams, directory organization charts, organizational charts, timelines, fishbone diagrams, tables, etc.
- [x] 4. Built-in hundreds of rich and beautiful themes, also supports custom themes and AI-generated themes.
- [x] 5. Nodes support adding rich content: text, images, links, icons, notes, attachments, tags, summary nodes, association lines, borders, markers, to-dos, descriptions, numbering, mathematical formulas, etc.
- [x] 6. Supports importing files in XMind, FreeMind, Markdown, Txt, Xlsx, etc.; supports exporting to PNG, XMind, SVG, PDF, Markdown, Txt, Xlsx, FreeMind, Mermaid, Html, etc.
- [x] 7. Rich style settings: text, borders, background, shape, lines, inner/outer margins, image tag layout, etc.
- [x] 8. Supports practical and interesting features: historical version management, presentation mode, AI generation, hand-drawn style, outline editing, watermark, scrollbars, sibling node alignment, minimap, entering specific nodes, rainbow lines, bidirectional node linking, search and replace, etc.
Supports Windows, Mac, and Linux systems; supports 中文简体、繁體中文、English、Tiếng Việt、Русский、日本語、한국어、Deutsch、Français、Português languages.
Download links: [Github](https://github.com/wanglin2/mind-map/releases), [Baidu Netdisk](https://pan.baidu.com/s/1C8phEJ5pagAAa-o1tU42Uw?pwd=jqfb), [Quark Netdisk](https://pan.quark.cn/s/2733982f1976)、[Microsoft App Store](https://apps.microsoft.com/detail/9p58vg94khcq?hl=zh-CN&gl=CN)
> If the software fails to open after installation on macOS, showing an error like **untrusted** or **moved to trash**, execute the following command and then restart:
> ``` shell
> sudo xattr -d com.apple.quarantine /Applications/思绪思维导图.app
> ```
- Obsidian Plugin
Download link: [Github](https://github.com/wanglin2/obsidian-simplemindmap/releases)
- UTools Plugin
Available in the [uTools](https://www.u.tools/) plugin market. You can search for `思绪` directly in the uTools plugin market to install it, or visit this address directly: [Homepage](https://www.u-tools.cn/plugins/detail/%E6%80%9D%E7%BB%AA%E6%80%9D%E7%BB%B4%E5%AF%BC%E5%9B%BE/), and click the 【Launch】 button on the right to install.
---
## File: README_MORE_EN.md
# Features
- [x] Plugin-based architecture. Apart from core functionalities, other features are provided as plugins, allowing on-demand use to reduce bundle size.
- [x] Supports various structures: Logical Structure Diagrams (left, right), Mind Maps, Organizational Charts, Directory Organization Charts, Timelines (horizontal, vertical), Fishbone Diagrams, etc.
- [x] Built-in multiple themes, allows high customization of styles, supports registering new themes.
- [x] Node content supports text (plain text, rich text), images, icons, hyperlinks, notes, tags, summaries, mathematical formulas.
- [x] Nodes support drag-and-drop (move, free resize), multiple node shapes; supports extending node content, supports using DDM for fully custom node content.
- [x] Supports canvas dragging and zooming.
- [x] Supports two methods for multi-selecting nodes: mouse button drag selection and Ctrl+left click.
- [x] Supports export to `json`, `png`, `svg`, `pdf`, `markdown`, `xmind`, `txt`; supports import from `json`, `xmind`, `markdown`.
- [x] Supports shortcuts, undo/redo, associative lines, search/replace, mini-map, watermark, scrollbars, hand-drawn style, rainbow lines, markers, outer frames.
- [x] Provides rich configuration options to meet various scenarios and usage habits.
- [x] Supports collaborative editing.
- [x] Supports presentation mode.
- [x] More features await your discovery.
The following plugins are officially provided and can be imported as needed (if a feature doesn't work, it's likely because the corresponding plugin hasn't been imported). Please refer to the documentation for specific usage:
| RichText (Node Rich Text Plugin) | Select (Mouse Multi-Select Node Plugin) | Drag (Node Drag Plugin) | AssociativeLine (Associative Line Plugin) |
| ------------------------------------- | ----------------------------------------- | ------------------------------------- | ----------------------------------------- |
| Export (Export Plugin) | KeyboardNavigation (Keyboard Navigation Plugin) | MiniMap (Mini-Map Plugin) | Watermark (Watermark Plugin) |
| TouchEvent (Mobile Touch Event Support Plugin) | NodeImgAdjust (Drag to Adjust Node Image Size Plugin) | Search (Search Plugin) | Painter (Node Format Painter Plugin) |
| Scrollbar (Scrollbar Plugin) | Formula (Mathematical Formula Plugin) | Cooperate (Collaborative Editing Plugin) | RainbowLines (Rainbow Lines Plugin) |
| Demonstrate (Presentation Mode Plugin) | OuterFrame (Outer Frame Plugin) | MindMapLayoutPro (Mind Map Layout Plugin) | |
Features that will **not** be implemented in this project:
> 1. Free nodes, i.e., multiple root nodes.
>
> 2. Adding nodes after a summary node.
>
> If you need the above features, this library may not meet your requirements.
# Installation
```bash
npm i simple-mind-map
```
# Usage
Provide a container element with non-zero width and height:
```html
```
Also, set the following CSS styles:
```css
#mindMapContainer * {
margin: 0;
padding: 0;
}
```
Then create an instance:
```js
import MindMap from "simple-mind-map";
const mindMap = new MindMap({
el: document.getElementById("mindMapContainer"),
data: {
data: {
text: "Root Node",
},
children: [],
},
});
```
You will get a mind map. Want to implement more features? Check the [Development Documentation](https://wanglin2.github.io/mind-map-docs/).
# License
[MIT](./LICENSE). Commercial use is permitted freely as long as the `simple-mind-map` copyright notice and attribution are retained. If you have questions or wish to remove these requirements, please contact the author (WeChat: wanglinguanfang) for a paid option to remove them.
> Example: You can add the following content on any page of your application, such as the About page, Help page, Documentation page, Open Source Notice, etc.:
>
> The mind map feature of this product is developed based on the SimpleMindMap project. The copyright belongs to the original project. [Open Source License](https://github.com/wanglin2/mind-map/blob/main/LICENSE).
# Development Help / Technical Support / Consulting
Due to limited time and a shift in focus, we currently do not provide any development support (including paid support). Thank you for your understanding!
# Star
If you like this project, welcome to give it a star. It means a lot to us.
[](https://star-history.com/#wanglin2/mind-map&Date)
---
## File: README_MORE_ZH.md
# 特性
- [x] 插件化架构，除核心功能外，其他功能作为插件提供，按需使用，减小打包体积
- [x] 支持逻辑结构图（向左、向右逻辑结构图）、思维导图、组织结构图、目录组织图、时间轴（横向、竖向）、鱼骨图等结构
- [x] 内置多种主题，允许高度自定义样式，支持注册新主题
- [x] 节点内容支持文本（普通文本、富文本）、图片、图标、超链接、备注、标签、概要、数学公式
- [x] 节点支持拖拽（拖拽移动、自由调整）、多种节点形状；支持扩展节点内容、支持使用 DDM 完全自定义节点内容
- [x] 支持画布拖动、缩放
- [x] 支持鼠标按键拖动选择和 Ctrl+左键两种多选节点方式
- [x] 支持导出为`json`、`png`、`svg`、`pdf`、`markdown`、`xmind`、`txt`，支持从`json`、`xmind`、`markdown`导入
- [x] 支持快捷键、前进后退、关联线、搜索替换、小地图、水印、滚动条、手绘风格、彩虹线条、标记、外框
- [x] 提供丰富的配置，满足各种场景各种使用习惯
- [x] 支持协同编辑
- [x] 支持演示模式
- [x] 更多功能等你来发现
官方提供了如下插件，可根据需求按需引入（某个功能不生效大概率是因为你没有引入对应的插件），具体使用方式请查看文档：
| RichText（节点富文本插件） | Select（鼠标多选节点插件） | Drag（节点拖拽插件） | AssociativeLine（关联线插件） |
| ------------------------------------ | ----------------------------------------- | ------------------------------------ | ------------------------------------ |
| Export（导出插件） | KeyboardNavigation（键盘导航插件） | MiniMap（小地图插件） | Watermark（水印插件） |
| TouchEvent（移动端触摸事件支持插件） | NodeImgAdjust（拖拽调整节点图片大小插件） | Search（搜索插件） | Painter（节点格式刷插件） |
| Scrollbar（滚动条插件） | Formula（数学公式插件） | Cooperate（协同编辑插件） | RainbowLines（彩虹线条插件） |
| Demonstrate（演示模式插件） | OuterFrame（外框插件） | MindMapLayoutPro（思维导图布局插件） | |
本项目不会实现的特性：
> 1.自由节点，即多个根节点；
>
> 2.概要节点后面继续添加节点；
>
> 如果你需要以上特性，那么本库可能无法满足你的需求。
# 安装
```bash
npm i simple-mind-map
```
# 使用
提供一个宽高不为 0 的容器元素：
```html
```
另外再设置一下`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
[MIT](./LICENSE)。保留`simple-mind-map`版权声明和注明来源的情况下可随意商用，如有疑问或不想保留可联系作者（微信：wanglinguanfang）通过付费的方式去除。
> 示例：可以在你应用中的关于页面、帮助页面、文档页面、开源声明等任何页面添加以下内容：
>
> 本产品思维导图基于SimpleMindMap项目开发，版权归源项目所有，[开源协议](https://github.com/wanglin2/mind-map/blob/main/LICENSE)。
# 开发帮助/技术支持/咨询等
因精力有限，及重心转变，暂不提供任何开发支持（包括有偿），请见谅！
# star
如果喜欢本项目，欢迎点个 star，这对我们很重要。
[](https://star-history.com/#wanglin2/mind-map&Date)
# 关于定制
如果你有个性化的商用定制需求，可以联系我们，我们提供付费开发服务，无论前端、后端、还是部署，都可以帮你一站式搞定。
# 谁在使用
| **drawon.cn(桌案)** |
| --- |
# 感谢赞赏过本项目的人
## 最强王者
| **hi** |
| --- |
## 钻石赞助
| **黄智彪@一米一栗科技** | **沨沄** | **行** |
| --- | --- | --- |
## 黄金赞助
| **小土渣的宇宙** | **Chris** | **仓鼠** | **风格** | **LiuJL** | **Kyle** | **秀树因馨雨** | **黄泳** | **ccccs** | **炫** |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| **晏江** | **梁辉** | **千帆** | **布林** | **达仁科技** | **沐风牧草** | **俊奇** | **庆国** | **Matt** | **雨馨** |
| **峰** | **御风** | **兔子快跑** | **LSHM** | **newplayer** | | | | | |
## 青铜赞助
| **Think** | **志斌** | **qp** | **ZXR** | **花儿朵朵** | **suka** | **水车** | **才镇** | **小米bbᯤ²ᴳ** | ***棐** |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| **南风** | **蜉蝣撼大叔** | **乙** | **敏** | **有希** | **樊笼** | **小逗比** | **天清如愿** | **敬明朗** | **飞箭** |
| **戚永峰** | **moom** | **张扬** | **长沙利奥软件** | **HaHN** | **继龙** | **欣** | **易空小易** | **国发** | **建明** |
| **汪津合** | **博文** | **慕智打印-兰兰** | **锦冰** | **旭东** | **橘半** | **pluvet** | **皇登攀** | **SR** | **逆水行舟** |
| **L** | **sunniberg** | **sunniberg** | **在下青铜五** | **木星二号** | **阿晨** | **铁** | **Alex** | **子豪** | **宏涛** |
| **最多5个字** | **ZX** | **协成** | **木木** | **好名字** | **lsytyrt** | **buddy** | **小川** | **Tobin** | **夏虫不语冰** |
| **晴空** | **。** | **Jeffrey** | **张文建** | **Lawliet** | **一叶孤舟** | **Eric** | **Joe** | **中文网字计划-江夏尧** | **海云** |
| **皮老板** | **h.r.w** | **时光匆匆** | **广兴** | **一亩三** | **xbkkjbs0246658** | **4399行星元帅** | **Xavier** | **:)** | **可米阳光** |
| **MrFujing** | **Sword** | **好好先生Ervin** | **胡永刚** | **旋风** | **星夜寒** | **神话** | **Towards the future** | **安嘉** | |