wfxr / Minimap.vim
Programming Languages
Projects that are alternatives of or similar to Minimap.vim
📡 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-minimapis 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'}
📑 Example configuration
let g:minimap_width = 10
let g:minimap_auto_start = 1
let g:minimap_auto_start_win_enter = 1
🛠 Commands
| Flag | Description |
|---|---|
| Minimap | Show minimap window |
| MinimapClose | Close minimap window |
| MinimapToggle | Toggle minimap window |
| MinimapRefresh | Force refresh minimap window |
| MinimapUpdateHighlight | Force update minimap highlight |
⚙ Options
| Flag | Default | Description |
|---|---|---|
g:minimap_auto_start |
0 |
if set minimap will show at startup |
g:minimap_auto_start_win_enter |
0 |
if set with g:minimap_auto_start minimap shows on WinEnter
|
g:minimap_width |
10 |
the width of the minimap window in characters |
g:minimap_highlight |
Title |
the color group for current position |
g:minimap_base_highlight |
Normal |
the base color group for minimap |
g:minimap_block_filetypes |
['fugitive', 'nerdtree', 'tagbar' ] |
disable minimap for specific file types |
g:minimap_block_buftypes |
['nofile', 'nowrite', 'quickfix', 'terminal', 'prompt'] |
disable minimap for specific buffer types |
g:minimap_close_filetypes |
['startify', 'netrw', 'vim-plug'] |
close minimap for specific file types |
g:minimap_close_buftypes |
[] |
close minimap for specific buffer types |
g:minimap_left |
0 |
if set minimap window will append left |
💬 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. Welcome to contribute!
Minimap window is too wide for me, how to use it as a simple scrollbar?
You can reduce the width of the minimap window:
let g:minimap_width = 2
Or use scrollbar.nvim instead if what you want is a pure scrollbar indicator.
I don't like the default highlight group, how to change it?
Choose any one of the highlight groups (or define a new one) and just set it for minimap like this:
hi MinimapCurrentLine ctermfg=Green guifg=#50FA7B guibg=#32302f
let g:minimap_highlight = 'MinimapCurrentLine'
All existed Highlight groups can be displayed by :hi.
Minimap shows up as a jumble of characters?
Check that your encoding is set to utf-8 and not latin1 (for Vim users).
Also, ensure that you're using a Unicode-compatible font that has Braille characters in it.
📦 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.
🌼 Maintainers
 |
 |
|---|---|
| wfxr | rabirabirara |
📃 License
MIT (c) Wenxuan Zhang