Markdown Mindmap

🚀 Mindmap Server-side Mind Map Implementation

This project enables the conversion of Markdown into mind maps. It offers multiple installation methods and provides an easy - to - use experience for generating mind maps from Markdown content.

🚀 Quick Start

Usage Examples

In Claude, you can make requests like these:

"Please generate a mind map for the following Markdown code:

# Project Planning
## Research
### Market Analysis
### Competitor Evaluation
## Design
### Wireframes
### Template Diagrams
## Development
### Front - end
### Back - end
## Testing
### Unit Testing
### User Testing

"

"Please convert the following Markdown content into a mind map and open the generated file in the terminal. Markdown content:

# Core Competitiveness Analysis
## Technological Advantages
### Open - source Technology Stack
### Cloud - native Support
## Market Positioning
### Enterprise - level Applications
### Consumer Market
## Business Model
### Subscription System
### Advertising Revenue

"

"Please think in detail about the process of putting an elephant in a refrigerator and generate a mind map. Then open it via the terminal."

✨ Features

• Convert Markdown into interactive HTML mind maps.
• Support offline - usable mind maps.
• Optionally show or hide the toolbar.
• Return HTML content or file paths.

📦 Installation

Method 1: Install via npm Package Manager

1. Open the terminal.
2. Run the following command for global installation:

npm install -g markmap-cli

3. Verify the installation by running:

markmap --version

Method 2: Install via Docker

1. Pull the image:

docker pull yuchen/mindmap-server:latest

2. Run the container:

docker run -it --rm -v /path/to/output:/output yuchen/mindmap-server:latest

Method 3: Manual Compilation

1. Clone the repository:

git clone https://github.com/YuChenSSR/mindmap-mcp-server.git

2. Install dependencies:

cd mindmap-mcp-server
npm install

3. Start the service:

node index.js

🔧 Troubleshooting

Issue: Output directory not found

mkdir -p /path/to/output
chmod 755 /path/to/output

Issue: Docker command not found

1. Check if Docker is installed:

docker --version

2. Start the Docker service:

sudo systemctl start docker

3. Add the current user to the Docker group:

sudo usermod -aG docker $USER

4. Log in again and verify if it works.

Issue: Server not shown in Claude

1. Check if the service is started and running.
2. Make sure the firewall settings allow communication on the relevant ports.
3. Check the log files for detailed error information.

⚠️ Important Note

The three installation methods have been successfully tested on macOS and Linux systems. For Windows users, if you encounter issues when using npx, it is recommended to choose the Docker method. Additionally, if you use Visual Studio Code, you can consider installing the "Markmap" plugin for a more convenient experience.

📄 Summary

With this guide, you can easily convert Markdown into mind maps and view them in the terminal. If you have any questions or suggestions, please feel free to contact us.

Thank you for your attention and support for the Mindmap project! We hope our tool will bring you convenience and contribute to technological progress!