Home

Awesome

<p align="center"> <img src="/ascii.png", width="600", height="400", title="vim.reaper"/> </p> <p align="center">💀 A Hackable, Fully Featured, Rice Friendly Neovim Configuration 💀</p> <p align="center"> <a href="#features">Features</a> • <a href="#installation">Installation</a> • <a href="#usage">Usage</a> • <a href="#required-tools">Required Tools</a> <br> <br> <a href="https://github.com/gideonwolfe/vim.reaper/stargazers"> <img src="https://img.shields.io/github/stars/gideonwolfe/vim.reaper.svg?style=flat-square&logo=hackaday"/> </a> <a href="https://github.com/gideonwolfe/vim.reaper/commits/master"> <img src="https://img.shields.io/github/last-commit/gideonwolfe/vim.reaper.svg?style=flat-square&logo=vim"/> </a> <a href="http://hits.dwyl.com/GideonWolfe/vimreaper.svg"> <img src="http://hits.dwyl.com/GideonWolfe/vimreaper.svg"/> </a> <p align="center"> <img src="https://stars.medv.io/GideonWolfe/vim.reaper.svg", title="commits"/> </p>

Features

Installation

The update_config.sh script simply copies the nvim folder into your $HOME/.config directory. This script can also be used to update configurations that you have modified or have been updated from git.

Before installing for the first time, go into the vim.reaper/nvim directory and run nvim -u init.vim. This will tell neovim to launch using this configuration file. This lets you fully get everything up and running before you commit to puting it in .config. Back up any old configs!

Usage

Keybindings

Click to expand

<details><summary><code>Basic keybinds</code> 🔑</summary> <p>
FunctionKeybind
Leader KeySPACE
Exit insert modejk or kj
</p> </details> <details><summary><code>Editing</code> 🧬</summary> <p>
FunctionKeybind
NERDComment toggle comment<Leader>nc
NERDComment sexy comment<Leader>ns
NERDComment append comment<Leader>na
NERDComment uncomment<Leader>nu
NERDComment comment<Leader>n
NERDComment invert<Leader>ni
Table Mode Toggle<Leader>tm
Convert to Table<Leader>tt
</p> </details> <details><summary><code>Navigation</code> 🚀</summary> <p>
FunctionKeybind
Navigate to left windowCtrl+h
Navigate to right windowCtrl+l
Navigate to top windowCtrl+k
Navigate to bottom windowCtrl+j
Horizontal split then move to bottom window<Leader>+Ctrl+s
Horizontal split then move to right window<Leader>+Ctrl+l
Next tabTab
Previous tabShift+Tab
Kill buffer<Leader>bk
Scroll upCtrl+j or mouse scroll
Scroll downCtrl+k or mouse scroll
Easymotion find word<Leader><Leader>+w
Easymotion find end of word<Leader><Leader>+e
Easymotion find character<Leader><Leader>+f
Easymotion find two characters<Leader><Leader>+s
</p> </details> <details><summary><code>coc.nvim</code> 💭</summary> <p>
FunctionKeybind
Open completion windowTab
Accept completionEnter
coc-definition<Leader>cd
coc-type-definition<Leader>ctd
coc-type-implementation<Leader>ci
coc-references<Leader>cr
coc-rename<Leader>crn
coc-format-selected<Leader>cf
coc-fix-current<Leader>cfl
:CocList diagnostics<Leader>cdi
:CocList extensions<Leader>ce
:CocList commands<Leader>cc
:CocList outline<Leader>co
</p> </details> <details><summary><code>git</code> 🔀</summary> <p>
FunctionKeybind
:Gstatus<Leader>gs
:Gdiffsplit<Leader>gd
:Gcommit<Leader>gc
:Gpush<Leader>gp
:Gpull<Leader>gP
:Gmove<Leader>gm
:Gmerge<Leader>gM
:Gbrowse<Leader>gb
:CocCommand git.browserOpen<Leader>gbl
:CocCommand git.chunkInfo<Leader>gh
:CocCommand git.showCommit<Leader>gsc
:CocCommand git.toggleGutters<Leader>gg
:ToggleLazyGit<Leader>lg
</p> </details> <details><summary><code>Translation </code> 🌐</summary> <p>
FunctionKeybind
:Translate<Leader>t
:TranslateW<Leader>tw
:TranslateR<Leader>tr
</p> </details> <details><summary><code>LaTeX </code> 📜</summary> <p>
FunctionKeybind
:VimtexCompile<Leader>lc
:VimtexCompileSelected<Leader>ls
:VimtexInfo<Leader>li
:VimtexTocToggle<Leader>lt
:VimtexView<Leader>lv
</p> </details> <details><summary><code>Misc</code> 🧰</summary> <p>
FunctionKeybind
:ToggleLazyDocker<Leader>ld
:MarkdownPreview<Leader>md
</p> </details>

Check mappings.vim for a complete list of keybinds.

Startify

To open Neovim to the startify buffer, simply launch nvim without any arguments. Your recently edited files will be displayed, as well as recently edited files from the current directory.

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/startify.png?" width="640" height="360" title="startify"> </p>

Completion

In the middle of a word, you can press Tab to open the Coc floating completion menu and cycle through options. This menu should be populated with sippets from UltiSnips, smart complete from TabNine, and any other completion suggestions. Press Shift+Tab to go up in the menu, and Enter to select an option.

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/completion.png" width="640" height="360" title="coc"> </p> Note: Windows are set to the background color because the other colors look gross IMO. Ideally we could have a border on the floating windows but that is not implemented in CoC yet.

NERDTree

In any buffer, press F7 to open the NERDTree file browser. Optionally disable the nerdtree-highlights plugin if you don't want syntax highlighting in NT.

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/nerdtree.png" width="640" height="360" title="nerdtree"> </p>

Airline

Tabline

The tabline will display the currently open buffers, and whether they have been modified.

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/tabline.png" width="940" height="13" title="tabline"> </p>

Statusbar

The status bar displays the current editing mode, git hunks, git branch with branch status, the modified status of the buffer, the filename and filetype, the character encoding method, progress through file, and warnings/errors found by linter.

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/statusbar.png" width="940" height="23" title="statusbar"> </p>

Vista

I am still ironing out the kinks in my vista config (specifically with C files), but it should work pretty well for most filetypes. Press F8 to toggle the Vista window.

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/vista.png" width="640" height="360" title="vista"> </p>

For quick location of tags, you can activate the Vista finder fuzzyfinder by pressing <Leader>ft

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/vistafuzzy.png" width="640" height="360" title="vistafzf"> </p>

To navigate the fzf menu, you can type the name of the tag or use Ctrl+j or Ctrl+k

LazyGit and LazyDocker

LazyGit and LazyDocker give you a convenient TUI portal to your current git repo or docker stack. They can be brought up with <Leader>lg and <Leader>ld respectively.

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/lazygit.png" width="640" height="360" title="lazygit"> </p> <p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/lazydocker.png" width="640" height="360" title="lazydocker"> </p>

Translator

By default I set the target language to french. This option is configurable in the plugin-settings, plus a ton of other options for that plugin I'm not even using at the moment.

Here's what it looks like if you translate a phrase to a window with <Leader>tw.

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/translate.png" title="translator"> </p>

Markdown

While editing a markdown document, press <Leader>md to open a live preview of your document. You must edit the plugin settings to point to the absolute filepath of the css file. This shoud just mean changing the username.

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/markdown.png" title="markdown"> </p>

If you are running pywal, your colors will be dynamically sourced!

LaTeX

While editing a LaTeX document, press <Leader>lc to start automatic compilation.

<p align="center"> <img src="https://gideonwolfe.com/img/neovim/reaper/latex.png" title="latex"> </p>

use zathura pywal for the most cohesive theme!

Required tools

These must be installed to make use of all the awesome features

Notes

vim.reaper is only part of a balanced linux diet. Check out my dotfiles for more ricing goodness. Please feel free to let me know about any errors, or create PRs that expand the configuration or make it more robust on different systems.

<p align=center> <a href="https://gideonwolfe.com"> <img src="https://forthebadge.com/images/badges/60-percent-of-the-time-works-every-time.svg"/> </p>