Skip to content

squpvc/mind-map

 
 

Repository files navigation

Simple mind map

npm-version npm download GitHub issues license GitHub stars GitHub forks

English Name: Mind Map. A simple & powerful web mind mapping library and mind mapping software.

This project mainly includes the following:

  • A js mind map library that doesn't depend on any framework, which can be used to quickly develop web mind map products.

Development Documentation: https://wanglin2.github.io/mind-map-docs/

  • A web-based mind map application, developed based on the mind map library, Vue2.x, and ElementUI. It supports operating local computer files and can be used as an online mind map application, or self-hosted and further developed.

Online Address: https://wanglin2.github.io/mind-map/

  • Client and Plugins
  1. Standalone client, supporting Windows, Mac, and Linux systems.

Download: Github, Baidu Netdisk

  1. uTools plugin, now available in the uTools plugin marketplace.

You can search for Mind Map in the uTools plugin marketplace to install, or directly visit this link: Homepage, and click the 【Start】 button on the right to install.

  1. obsidian plugin, the first version has been released:

Download: https://github.com/wanglin2/obsidian-simplemindmap/releases

  • Cloud storage version: If you need a version with backend cloud storage, you can try our other project Ideal Document.

Features

  • Plugin-based architecture, with core functionality and additional features provided as plugins for on-demand use, reducing bundle size
  • Supports various structures including logic diagrams (left, right), mind maps, organizational charts, directory organization charts, timelines (horizontal, vertical), fishbone diagrams, etc.
  • Built-in multiple themes, allowing highly customizable styles, supports registering new themes
  • Node content supports text (plain text, rich text), images, icons, hyperlinks, notes, tags, summaries, and mathematical formulas
  • Nodes support drag-and-drop (move, free adjustment), various node shapes; supports extending node content, fully customizable node content using DDM
  • Supports canvas dragging and zooming
  • Supports two methods for multi-selecting nodes: mouse button drag selection and Ctrl+left click
  • Supports exporting to json, png, svg, pdf, markdown, xmind, txt, and importing from json, xmind, markdown
  • Supports keyboard shortcuts, undo/redo, associative lines, search and replace, minimap, watermark, scrollbars, hand-drawn style, rainbow lines, markers, and borders
  • Provides rich configurations to meet various usage habits in different scenarios
  • Supports collaborative editing
  • Supports presentation mode
  • More features waiting for you to discover

The following official plugins are available and can be imported as needed (if a feature doesn't work, it's likely because you haven't imported the corresponding plugin). Please refer to the documentation for specific usage:

RichText(节点富文本插件) Select(鼠标多选节点插件) Drag(节点拖拽插件) AssociativeLine(关联线插件)
Export(导出插件) KeyboardNavigation(键盘导航插件) MiniMap(小地图插件) Watermark(水印插件)
TouchEvent(移动端触摸事件支持插件) NodeImgAdjust(拖拽调整节点图片大小插件) Search(搜索插件) Painter(节点格式刷插件)
Scrollbar(滚动条插件) Formula(数学公式插件) Cooperate(协同编辑插件) RainbowLines(彩虹线条插件)
Demonstrate(演示模式插件) OuterFrame(外框插件) MindMapLayoutPro(思维导图布局插件)

Features that will not be implemented in this project:

  1. Free nodes, i.e., multiple root nodes;

  2. Adding nodes after summary nodes;

If you need the above features, this library may not meet your requirements.

Installation

npm i simple-mind-map

Usage

Provide a container element with non-zero width and height:

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

Also, set up the css styles:

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

Then create an instance:

import MindMap from "simple-mind-map";

const mindMap = new MindMap({
  el: document.getElementById("mindMapContainer"),
  data: {
    data: {
      text: "Root Node",
    },
    children: [],
  },
});

You'll get a mind map. Want to implement more features? Check out the Development Documentation.

License

MIT. You can use it commercially as long as you retain the simple-mind-map copyright notice and indicate the source. If you have any questions or wish to remove these requirements, please contact the author for a paid option.

Example: You can add the following content to any page in your application, such as the About page, Help page, Documentation page, Open Source Notice, etc.:

The mind map in this product is developed based on the SimpleMindMap project. All rights belong to the original project, Open Source License.

WeChat Group

Add wanglinguanfang on WeChat to join the group. Based on past experience, most issues can be resolved by checking the issue list or documentation. Therefore, please make sure you've read all the documentation before asking questions. If your question isn't covered in the documentation, feel free to ask in the group instead of private messaging the author. If you must contact the author privately, please sponsor this project first (¥200+).


WeChat Official Account

If you like this project, please give it a star. It means a lot to us.

Star History Chart

About Customization

If you have personalized commercial customization needs, you can contact us. We provide paid development services, whether it's frontend, backend, or deployment, we can help you with a one-stop solution.

Who's Using This


drawon.cn (桌案)

Buy Me a Coffee

Open source is not easy. If this project has helped you, consider buying the author a coffee~ Your sponsorship is very important for the sustainable development of the project and is the greatest motivation for the author to continue maintenance.

Alipay is recommended as WeChat cannot retrieve avatars. Please add the note 【Mind Map Sponsorship】 when transferring.

Sponsorship Levels: Challenger (¥500+), Grandmaster (¥300+), Diamond (¥200+), Gold (¥100+), Bronze

Challenger


hi

Diamond Sponsors


黄智彪@一米一栗科技

沨沄

Gold Sponsors


小土渣的宇宙

Chris

仓鼠

风格

LiuJL

Kyle

秀树因馨雨

黄泳

ccccs


晏江

梁辉

千帆

布林

达仁科技

沐风牧草

俊奇

庆国

Matt

雨馨


御风

兔子快跑

LSHM

newplayer

Bronze Sponsors


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

安嘉

About

SimpleMindMap(思绪思维导图):一个强大的Web思维导图。A powerful web mind map.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 70.3%
  • Vue 28.4%
  • Other 1.3%