README.md

📡 minimap.vim

Blazing fast minimap for vim, powered by 🛰 code-minimap written in Rust.

✨ Features

• Blazing-fast (see benchmark).
• Dynamic scaling.
• Real-time highlight.
• It can be used to scroll buffer (in vim's way!).

📥 Installation

Requirement

• 🛰code-minimap is required. The plugin receives rendered minimap from it.
• vim8.2+, or neovim 0.5.0+.

Use your favorite plugin manager, vim-plug for example:

Plug 'wfxr/minimap.vim'

If you need to install the plugin manually, you can refer to this issue: #2.

You can use cargo to install 'code-minimap' simultaneously (Only recommended for rust users):

Plug 'wfxr/minimap.vim', {'do': ':!cargo install --locked code-minimap'}

🛠 Commands

⚙ Options

💬 F.A.Q

Highlight and scroll are not working properly.

Check the vim version you are using. minimap.vim requires vim 8.2+ or neovim 0.5.0+.

Integrated with diagnostics or git status plugins?

Not implemented currently but it should be possible. I am a beginner in vim plugin. I don't known how to implement such features correctly and efficiently. Welcome to contribute!

Minimap window is too wide for me, how to use it as a simple scrollbar?

You can decrease the minimap window width:

let g:minimap_width = 2

Or use scrollbar.nvim instead if what you want is a pure scrollbar indicator.

📦 Related Projects

• code-minimap: A high performance code minimap render.
• scrollbar.nvim: A pure scrollbar indicator for neovim (nightly).
• vim-minimap: A minimap plugin written in python.

📃 License

MIT (c) Wenxuan Zhang