Repository files navigation

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

• Blazing-fast (seebenchmark).
• Dynamicscaling.
• Real-timehighlight.
• It can be used toscroll buffer (in vim's way!).

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 usecargo to install 'code-minimap' simultaneously (Only recommended for rust users):

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

letg:minimap_width=10letg:minimap_auto_start=1letg:minimap_auto_start_win_enter=1

Minimap.vim sets its own color groups to give a reasonable default.

You can create your own colorgroup by specifying the foreground and background colors for the cterm or gui:

:highlight minimapCursor ctermbg=59  ctermfg=228 guibg=#5F5F5F guifg=#FFFF87

For more information, see:help highlight

Note: some colorschemes will clear all previous colors, so you may have to add anautocmd to ensure your custom colorgroups are added back:

autocmd ColorScheme *        \ highlight minimapCursor            ctermbg=59  ctermfg=228 guibg=#5F5F5F guifg=#FFFF87 |        \ highlight minimapRange             ctermbg=242 ctermfg=228 guibg=#4F4F4F guifg=#FFFF87

If you prefer to disable this behavior, setg:minimap_enable_highlight_colorgroup to 0 / false. This is useful if you have a color scheme that sets the minimap highlight groups explicitly.

Check the vim version you are using.minimap.vim requiresvim 8.2+ orneovim 0.5.0+.

Not implemented currently but it should be possible.Welcome to contribute!

update: Git support has been implemented#72.

You can reduce the width of the minimap window:

letg:minimap_width=2

Or usescrollbar.nvim instead if what you wantis a pure scrollbar indicator.

A higher priority color group will override a lower priority color group.By default, search > cursor/window position > git colors

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=#32302fletg:minimap_cursor_color='MinimapCurrentLine'

All existed Highlight groups can be displayed by:hi.

Check that your encoding is set toutf-8 and notlatin1 (for Vim users).Also, ensure that you're using a Unicode-compatible font that has Braille characters in it.

You can have the minimap highlight all the visible lines in your current windowby settingg:minimap_highlight_range. If you use Neovim, and your versionis recent enough (after November 7, 2020), you can set this option to updatethe highlight when the window is scrolled.

It is recommended that you create a mapping to run:nohlsearch and clear theminimap all in one action. For example:

nnoremap <silent> `` :nohlsearch<CR>:call minimap#vim#ClearColorSearch()<CR>

The version ofwc that ships with MacOS does not have support for the-L flag.To use background processing on MacOS, installgnu-wc. Example via homebrew:

brew install coreutils

• InstallTestify.
• From the top level directory (minimap.vim/)vim +TestifySuite for a yay/nayfrom your shell.
• For a more detailed run, open vim at the top level and run:TestifySuite.README.md works, but an empty buffer at the top level works too.
• To hone in on one test file, open that file (located in thet/ directory)and run:TestifyFile.
  • (As a note, thet/ directory is named such as a requirement fromTestify.:TestifySuite runs all the tests in thet/ directory)

• 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.

ZNielsen	wfxr	rabirabirara

MIT (c) Wenxuan Zhang