What is Markmap?
Markmap is a simple yet powerful tool that transforms markdown files into interactive, visual mindmaps. It eliminates the need for complex mindmapping software—just write markdown, and Markmap handles the rest. The result is a beautiful, interactive HTML visualization that you can share or embed.
Why Use Markmap?
- Simple: Write plain markdown, no special syntax needed
- Fast: Convert files instantly
- Interactive: Navigate, pan, zoom, and collapse/expand branches
- Shareable: Export as HTML for easy distribution
- Lightweight: Minimal dependencies, works in the browser
Installation
Install Markmap globally using npm:
npm install -g markmap-cli
How to Use
Basic Workflow
- Write your markdown file with a hierarchical structure using heading levels:
# Main Topic ## Subtopic 1 ### Detail 1.1 ### Detail 1.2 ## Subtopic 2 ### Detail 2.1
- Convert to HTML using the command line:
markmap your-file.md -o your-file.html
- Open the HTML file in your browser to view the interactive mindmap
Markdown Structure Tips
- Use
#for the root/central node - Use
##for main branches - Use
###,####, etc. for nested levels - Markdown formatting works: bold, italic,
code, links, etc. - Bullet points and numbered lists are also supported
Example
Input markdown (topics.md):
# Machine Learning ## Supervised Learning ### Classification ### Regression ## Unsupervised Learning ### Clustering ### Dimensionality Reduction ## Deep Learning ### Neural Networks ### CNNs and RNNs
Command:
markmap topics.md -o topics.html
Result: An interactive mindmap visualization opening in your browser with expandable/collapsible nodes, zoom, and pan capabilities.
Quick Tips
- Keyboard shortcuts: Most browsers support standard zoom and navigation
- Mouse interactions: Click on nodes to collapse/expand, scroll to zoom
- Rich content: Include links, code blocks, and formatting in your markdown
- Batch conversion: Markmap can process multiple files
When to Use Markmap
- Planning and brainstorming sessions
- Project structure visualization
- Study notes and concept mapping
- Documentation organization
- Process flowcharts
Markmap is perfect for when you want mindmap functionality without the overhead of specialized tools. Pure markdown simplicity with powerful visualization.
Documentation
For more details, check the official documentation at https://markmap.js.org/docs/markmap
