Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/severin-lemaignan/vim-minimap
A Sublime-like minimap for VIM, based on the Drawille console-based drawing library
https://github.com/severin-lemaignan/vim-minimap
Last synced: about 2 months ago
JSON representation
A Sublime-like minimap for VIM, based on the Drawille console-based drawing library
- Host: GitHub
- URL: https://github.com/severin-lemaignan/vim-minimap
- Owner: severin-lemaignan
- License: mit
- Created: 2014-07-24T12:21:38.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-03-18T09:19:37.000Z (over 3 years ago)
- Last Synced: 2024-08-01T03:40:54.144Z (4 months ago)
- Language: Python
- Size: 440 KB
- Stars: 701
- Watchers: 20
- Forks: 32
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- stars - severin-lemaignan/vim-minimap - like minimap for VIM, based on the Drawille console-based drawing library (Tutorial / Windows Manager)
- awesome-list - vim-minimap - like minimap for VIM, based on the Drawille console-based drawing library | severin-lemaignan | 689 | (Python)
README
A code minimap for Vim
======================
The Sublime text-editor can display an useful overview of the code as a
*minimap* sidebar.
We can implement the same thing in Vim, relying on the [Drawille
library](https://github.com/asciimoo/drawille) to 'draw' in text mode.
This code is made available under a MIT license. See [LICENSE](LICENSE) for
details.
Features
--------
- displays the minimap of the currently active buffer (and updates when
switching to a different buffer)
- synchronized scrolling
- live update while typing
Installation
------------
Note that this extension requires Vim with Python support.
### Vundle
With [vundle](https://github.com/gmarik/Vundle.vim), simply add: `Plugin
'severin-lemaignan/vim-minimap'` to your `.vimrc` and run `:PluginInstall` from
vim.
### Janus
With Janus just clone inside ```.janus```.
```
cd ~/.janus
git clone https://github.com/severin-lemaignan/vim-minimap.git vim-minimap
```
### AUR
AUR just has [vim-minimap-git](https://aur.archlinux.org/packages/vim-minimap-git/) package.
Usage
-----
`:Minimap` to show the minimap, `:MinimapClose` to hide it.
Default mappings: `mm` to display the minimap, `mc` to close it.
To overwrite the default keybindings, using following settings in ``.vimrc'':
```
let g:minimap_show='ms'
let g:minimap_update='mu'
let g:minimap_close='gc'
let g:minimap_toggle='gt'
```
Settings
--------
You can customize the color of the highlighting by setting `g:minimap_highlight` in your vimrc:
`let g:minimap_highlight='Visual'`
Note: To find out which highlights are available on your vim installation use :hi to get the list.
Troubleshooting
---------------
### Weird display
> **Problem**:
>
> Certain fonts do not display plain dots and empty spaces, but
> plain dots and circles for braille characters.
>
> For example, with `Inconsolata`:
>
> 
>
> **Solution**:
>
> As a result, you may want to use any other font that display
> braille characters in a way that suit the minimap plugin,
> like `Ubuntu Mono`, or `Droid Sans Mono`.
>
> With `Ubuntu Mono`:
>
> 
>