Markmap Plus

Install from VS Code Marketplace · Project website · Source and issues

Markmap Plus is an independent fork of markmap-vscode by Gerald (@gera2ld). It is not affiliated with or endorsed by the original author. The original project is MIT licensed, and so is this fork. The fork exists because the upstream project is no longer actively maintained; it keeps the upstream feature set and adds improvements on top.

This extension integrates markmap into VS Code: preview your markdown as an interactive mind map.

Why a fork?

The upstream markmap-vscode has not been updated for a long time and pull requests are not being merged. Markmap Plus is published under its own extension ID so it can be iterated on independently, while staying compatible with the upstream feature set.

Migrating from markmap-vscode

1. Uninstall (or disable) the original markmap-vscode extension. Both extensions register a markdown custom editor, so keeping both installed leads to unpredictable behaviour.

2. Install Markmap Plus.

3. Copy your settings over — the keys were renamed to avoid clashing with the original extension:

   Old key	New key
   markmap.defaultOptions	markmapPlus.defaultOptions
   markmap.customCSS	markmapPlus.customCSS

   In settings.json:

   {
     "markmapPlus.defaultOptions": "{ \"colorFreezeLevel\": 2 }",
     "markmapPlus.customCSS": "markmap-view { --mm-link: rebeccapurple; }"
   }
   

4. Commands moved from the Markmap category to Markmap Plus in the Command Palette.

Features

• Preview markdown files as markmap
• Edit markdown files in a text editor and the markmap will update on the fly
• Themes and layouts, set in frontmatter
• Export as HTML, SVG or PNG
• Works offline

Usage

Command Palette

Open a markdown file. Then open the Command Palette (⇧⌘P) and search Open as markmap, press enter.

Context menu

Right click on a markdown file, then choose Open as markmap.

Button on title-bar

Open a markdown file. Find the markmap icon on the editor title-bar and click it.

Keyboard shortcuts

When the markmap preview is focused, the following single-key shortcuts are available. Press ? in the preview to show them.

Folding nodes

In the preview, left-click a branch node to fold or unfold its immediate children. Right-click it to fold or unfold the entire subtree. Ctrl/Cmd+click also toggles the whole subtree. Links and areas outside branch nodes keep their context menus.

When the Markdown editor is active, the Command Palette offers Markmap Plus: Toggle the active node and Markmap Plus: Toggle the active node recursively for the node at the text cursor. These commands have no default keybindings, so typing t or r in Markdown works normally. You can assign your own keybindings in VS Code if you want them.

Search

Press / to search the map. Matching branches stay open and everything else folds away, so a large document collapses to just the parts that match. Enter jumps to the next match, Shift+Enter to the previous one, and Esc clears the search and restores the fold state you had before.

Fold state

The branches you fold are remembered per file, so reopening a document shows the map the way you left it. Node ids are content hashes, so renaming a heading simply drops that node from the saved state instead of breaking it.

If you open the same document in more than one preview, folding a branch in one updates the others.

Export

Use the Export button in the toolbar to save the map as SVG, PNG or a standalone HTML page. Markdown exports the branches that are currently open as a nested list, which is handy for turning a large document into a summary.

Configuration

Custom CSS

Extra CSS for the page around the map. To change colors, set --mm-* properties on markmap-view. See Themes and layouts for the list.

markmap-view {
  --mm-link: rebeccapurple;
}

Default Options

Default options for Markmap as JSON, see Options. Options in the frontmatter of a document win over these.

Theme and Layout

markmapPlus.theme and markmapPlus.layout set the look of every map, so you do not have to repeat frontmatter in each document. They win over the theme and layout in a document's frontmatter.

Leave either empty to use the document's frontmatter, or the default.

Credits

• markmap — the rendering engine
• markmap-vscode by Gerald — the original VS Code integration this fork is based on

License

MIT. See LICENSE — the original copyright notice is preserved.