Repository files navigation

Visualize your Markdown as mindmaps with markmap

This plugin is based on vim'scoc-markmap, which I missed when moving to Neovim. If you wanna know more about mindmap check theirwebsite,docs and GitHubrepository. This plugin is compatible with Linux, MacOS, Windows, and Android Termux.

• yarn

--  [markdown markmap]--  https://github.com/Zeioth/markmap.nvim{"Zeioth/markmap.nvim",build="yarn global add markmap-cli",cmd= {"MarkmapOpen","MarkmapSave","MarkmapWatch","MarkmapWatchStop"},opts= {html_output="/tmp/markmap.html",-- (default) Setting a empty string "" here means: [Current buffer path].htmlhide_toolbar=false,-- (default)grace_period=3600000-- (default) Stops markmap watch after 60 minutes. Set it to 0 to disable the grace_period.  },config=function(_,opts)require("markmap").setup(opts)end},

Markmap.nvim provide the next commands:

Note that all these commands will always generate a.html file inhtml_output. Take advantage of this if you want to keep the graph.

Run:healthcheck markmap. This command will tell you the depencencies you are missing. If the command do not exist, it means you are using an async package manager, so double check the package is beign loaded. These are the most common issues you will find:

• Run

yarn global add markmap-cli

• Now try to run

markmap

If the executable is not found, that means you need to add yarn to your PATH. This is normally done in your .profile, bashrc, or zshrc file like this:

# PATH Exampleexport PATH="$HOME/.local/bin:\$HOME/.cargo/bin:\$HOME/.npm-global/bin:\$HOME/.yarn/bin:\$HOME/.config/yarn/global/node_modules/.bin:\$HOME/.local/share/gem/ruby/3.0.0/bin:\$HOME/.cargo/env:\/root/.local/share/gem/ruby/3.0.0/bin:\/usr/local/bin:\/usr/share/nvm/init-nvm.sh:\$PATH"

If you prefer using npm over yarn, you can, but double check that you have the user space correctly configured as in some systems this is not enabled by default (see here).

If you are on windows, the process is the same. But the place to set PATH may change from one windows version to another.

If you want to help me, please star this repository to increase the visibility of the project.