Guide · Open source
How to use markmap: turn Markdown outlines into mindmaps
Updated · written with AI from the project's own documentation and checked against our catalogue data
Markmap is an open-source tool (MIT licence, written in TypeScript) that turns Markdown into mindmaps you can view and explore in a browser. You write headings and nested lists as you normally would, and markmap draws them as a branching diagram. This guide explains how to try it, how to get the source, and where it is available as an editor plugin, so you can start turning your own outlines into maps.
markmapmarkmap/markmap · ★ 13.2k · MIT Install options & downloads Quick start
- 1Open the web editor. Go to https://markmap.js.org/repl in your browser. No install is needed to try it.
- 2Write a Markdown outline. Use headings for main topics and nested lists for subtopics, as you would in any Markdown note.
- 3Check the map. Look at the branching diagram that markmap draws from your outline and explore it in the browser.
- 4Clone the source if needed. Run git clone https://github.com/markmap/markmap to get the repository locally.
- 5Pick an editor plugin. If you work in VS Code, Neovim or Emacs, choose the matching plugin from the README list.
- 6Read the documentation. Visit https://markmap.js.org/docs for more detail on usage.
What markmap does with your Markdown
Markmap reads a Markdown outline and draws it as a mindmap. Headings and nested lists become the branches of the diagram, so the structure you already write in plain text is what you see on screen.
The project describes its purpose simply: visualise your Markdown as mindmaps. You keep writing plain text rather than placing nodes on a canvas.
Try markmap in the web editor
The fastest way to see how it works is the online editor. The README links to it as a way to try markmap without installing anything. Type or paste a Markdown outline and the mindmap is drawn from it.
The web editor is the install method listed for this project, and the README does not list any prerequisites for it.
- Open the markmap web editor at https://markmap.js.org/repl
- Write headings for top-level topics and nested lists for subtopics
- Explore the resulting map in the browser
Get the source code with git
If you want to work with the code itself, the README gives one command to clone the repository. Run it in the folder where you keep projects.
After cloning, the README points you to the full documentation for further setup details.
git clone https://github.com/markmap/markmapUse markmap inside your editor
If you prefer to stay in your editor, markmap has plugins. The README lists a VS Code extension, available on the Visual Studio Marketplace and Open VSX. For Vim and Neovim it lists coc-markmap, which is powered by coc.nvim, and markmap.vim, which works without coc.nvim. For Emacs it lists eaf-markmap, powered by EAF.
Pick the plugin that matches your editor and follow its own page for setup.
- VS Code: markmap-vscode extension
- Neovim: coc-markmap (uses coc.nvim) or markmap.vim (no coc.nvim needed)
- Emacs: eaf-markmap (uses EAF)
Find more detail and related tools
The README links to the markmap documentation at https://markmap.js.org/docs for more detail. It also lists other community projects, including an MCP server, AI agent integrations and a browser tool that generates a map from a plain-language description.
The README says this project is heavily inspired by dundalek's markmap, which is also listed as a comparable project.
- Documentation: https://markmap.js.org/docs
- Comparable projects named in the analysis: dundalek/markmap, Freeplane, XMind, Simplemind
What people use it for
- Turning meeting notes or study notes written in Markdown into a visual map of the topic
- Sketching the structure of an essay or article from a text outline before writing it
- Previewing a mindmap of a Markdown file inside VS Code or Neovim without leaving the editor
- Embedding Markdown-based mindmaps in your own web pages, as developers who build on the project might do
Frequently asked questions
Is markmap free to use?
Yes. The project is licensed under MIT, and the repository is open source. The README does not mention any paid tier.
How do I install markmap?
The README lists a web app as the install method and gives a git clone command for the source code. You can also try it directly in the online editor at markmap.js.org/repl. The README does not list any prerequisites.
Does markmap work in VS Code?
The README lists a markmap VS Code extension, available on the Visual Studio Marketplace and Open VSX. It lets you preview mindmaps from inside the editor.
Can I use markmap with Neovim?
Yes, according to the README. It lists coc-markmap, which is powered by coc.nvim, and markmap.vim, which works without coc.nvim.
Is markmap a drag-and-drop mindmap editor?
No. The README describes writing plain text rather than a visual editing interface. If you need to place and move nodes by hand, a tool like XMind or Freeplane may suit you better.
What are alternatives to markmap?
The analysis lists dundalek/markmap, Freeplane, XMind and Simplemind as comparable projects. Freeplane, XMind and Simplemind are not Markdown-based in the way markmap is, so choose based on whether you want to write text or draw visually.
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
Markmap suits people who already outline in Markdown and want a visual map of it, and developers who want to embed such maps in web pages. It is a poor fit if you want a drag-and-drop editor or hosted team collaboration, which the README does not describe.
Install options & downloads