markmap

What is markmap?

Markmap turns Markdown into an interactive mind map. Headings and list items become branches you can fold, zoom and pan. Other text, such as paragraphs and code, stays with its branch as a note.

# Trip

## Before

- Book flights
- Pack

## During

- See the sights

The easiest way to try it is the 👉 editor. You can also use it in:

VS Code 🚀
the command line, with @markmap/cli
Vim / Neovim, with coc-markmap
many other tools

Learn the basics

Writing maps: what becomes a branch, a note, or part of a label
Themes and layouts: the looks and shapes a map can take
Options: settings you can keep in the document itself
Magic comments: fold chosen branches

Add maps to your own pages

You want to	Use
Show maps on a page with a script	@markmap/autoloader
Add a map to an app	@markmap/element
Control everything from code	@markmap/view
Render without a browser	Use with Node.js

Coming from markmap-lib and markmap-view? See Migrating from 0.18.

Support

See the FAQ for common questions. If you still need help, feel free to ask in GitHub Discussions.

Credits

Originally inspired by dundalek's markmap.