Skip to content
Get packs

Guide · Open source

How to use mind-map: install the library and run the web app

Updated · written with AI from the project's own documentation and checked against our catalogue data

mind-map is a JavaScript mind map project called SimpleMindMap (思绪思维导图). It has an open-source library for drawing mind maps in a web page without a framework, and a web app built on that library that can be self-hosted. This guide shows you how to install the library, what the web app can do, and which parts are closed source so you can decide if it fits your project.

Simple mind mapwanglin2/mind-map · ★ 12.9k · MIT

Quick start

  1. 1Decide which part you need. Choose the open-source library for your own web product, or the web app for direct use or self-hosting.
  2. 2Install the library. Run npm install simple-mind-map in your project folder.
  3. 3Read the developer docs. Open the documentation at the homepage linked in the README to learn how to create a mind map in your page.
  4. 4Try the web app. Use the online version linked in the README to test editing before you commit to a setup.
  5. 5Download the desktop client if needed. Get the client from the GitHub releases page or the Microsoft Store link in the README, knowing it is closed source.
  6. 6Fix macOS launch issues. If the Mac app is blocked, run the quarantine removal command from the README and start the app again.

Understand the two parts of the project

The repository contains an open-source JavaScript library and a closed-source desktop client with plugins. The library is plain JavaScript with no framework required, and it is the basis for building a web mind map product.

The README also describes a web mind map app, built on the library with Vue2.x and ElementUI, that supports opening local files and can be used online or self-hosted and modified.

  • Open-source: the JavaScript library and the web app, both in this repository.
  • Closed-source: the desktop client (Windows, Mac and Linux) and the Obsidian and uTools plugins.
  • The README says the open-source library is in a low-maintenance state.

Install the mind-map library from npm

The README gives one install command for the library. The package name is simple-mind-map. The README lists no prerequisites for this step.

After installing, use the library in your own web page or app. The developer documentation is linked from the README at the project homepage.

npm install simple-mind-map

Use the web app or self-host it

The README links an online version of the web mind map app. It can also be self-deployed and customized. The README does not list the self-hosting steps, so check the source code and the developer documentation for setup details.

The web app supports operating on local files on your computer, according to the README.

  • Try the hosted online version linked in the README.
  • Self-host by deploying the web app from the source code if you need your own instance.
  • Modify the source for your own product if the license and your needs allow it (the project is MIT licensed).

Know what the desktop client offers

The desktop client is closed source but downloadable separately. The README says it works without a network connection and stores data locally. It is listed for Windows, Mac and Linux.

According to the README, the client supports many structure types, including mind maps, logic charts, org charts, timelines, fishbone diagrams and tables. It also lists import of XMind, FreeMind, Markdown, Txt and Xlsx files, and export to PNG, XMind, SVG, PDF, Markdown, Txt, Xlsx, FreeMind, Mermaid and Html.

  • Structure types: mind map, logic structure, tree organisation, org chart, timeline, fishbone and table.
  • Formats: XMind, FreeMind, Markdown, Txt and Xlsx import; PNG, XMind, SVG, PDF, Markdown, Txt, Xlsx, FreeMind, Mermaid and Html export.
  • Languages listed: Simplified and Traditional Chinese, English, Vietnamese, Russian, Japanese, Korean, German, French and Portuguese.

Handle macOS security warnings

If the macOS app will not open and shows a message about being untrusted or moved to the trash, the README gives one command to clear the quarantine flag. Run it, then open the app again.

sudo xattr -d com.apple.quarantine /Applications/思绪思维导图.app

Pick the right part for your goal

If you are a developer adding mind map editing to a product, the library is the starting point. If you want an app you can open in a browser or host yourself, the web app fits. If you need a fully open-source offline tool, this project does not meet that need, because the offline client is closed source.

Compare with jsMind, markmap and Mermaid if your needs are different, such as a simpler library or text-based diagrams.

What people use it for

  • Adding a mind map editor to your own web product using the JavaScript library.
  • Running a browser-based mind map app that you host yourself.
  • Converting mind maps between XMind, FreeMind, Markdown and other listed formats with the desktop client.
  • Using a mind map plugin inside Obsidian, as the README describes a separate Obsidian plugin.

Frequently asked questions

How do I install mind-map?

For the library, run npm install simple-mind-map. The README lists this as the install method and names no prerequisites. The desktop client is a separate download from the GitHub releases page or other links in the README.

Is mind-map free and open source?

The project is MIT licensed, but only the JavaScript library and web app are open source. The README says the desktop client and plugin code are not open source, although the client is downloadable.

Does mind-map work offline?

The README says the desktop client works without a network connection and stores data locally. The offline client is closed source, so if you need an open-source offline tool, this project does not fully meet that need.

Can I import XMind files into mind-map?

The README lists XMind import for the desktop client, along with FreeMind, Markdown, Txt and Xlsx. It does not list these import features for the open-source library.

Is mind-map still maintained?

The README says the open-source library is in a low-maintenance state. It says the client and plugins are in active development.

How does mind-map compare to jsMind, markmap and Mermaid?

jsMind, markmap and Mermaid are comparable projects. This project is a mind map library plus a web app and desktop client, so pick it if you need a full editing experience and format support. The README does not compare it to these projects, so test each one for your use case.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Use mind-map if you are a developer who wants a framework-free JavaScript mind map library, or you want a browser-based app you can host yourself. Pick another tool if you need active maintenance, a fully open-source offline app, or every desktop client feature in open source.

Install options & downloads