This repo hosts my Nvim configuration for all the platforms I am using (Linux, Windows and macOS). init.vim is the config entry point for terminal Nvim, and ginit.vim is the additional config file for GUI client of Nvim (I am using neovim-qt for now on Windows).

My configurations are heavily documented to make it as clear as possible. While you can download the whole repository and use it, it is not recommended though. Good configurations are personal. Everyone should have his or her unique config file. You are encouraged to copy from this repo the part you feel useful and add it to your own Nvim config.

See doc here on how to install Nvim's dependencies, Nvim itself, and how to set up on different platforms (Linux, macOS and Windows).

This config is always tested against the latest nvim master release. No backward compatibility is guaranteed.

• Plugin management via Packer.nvim.
• Code auto-completion via nvim-compe and nvim-lspconfig.
• Git integration via vim-fugitive.
• Better escaping from insert mode via better-escape.vim.
• Fuzzy searching in current project quickly via LeaderF.
• Faster code commenting via vim-commentary.
• Faster matching pair insertion and jump via delimitMate.
• Smarter and faster matching pair management (add, replace or delete) via vim-sandwich.
• Fast buffer jump via vim-sneak.
• Ultra fast snippet insertion via Ultisnips.
• Beautiful status line via vim-airline.
• Better quickfix list with nvim-bqf.
• Asynchronous code execution via asyncrun.vim.
• Code highlighting via nvim-treesitter.
• Code editing using true nvim inside browser via firenvim.
• Color theme via vim-gruvbox8 and other beautiful themes.
• Markdown writing and syntax highlighting via vim-markdown, Markdown Previewing via markdown-preview.nvim.
• Command line auto-completion via wilder.nvim.
• Animated GUI style notification via nvim-notify.
• Smooth scroll experience via neoscroll.
• Tags navigation via vista.
• Code formatting via Neoformat.
• Undo management via vim-mundo
• LaTeX editing via vimtex ¹.
• ......

Go to a string starting with se

For more UI demos, see here.

Some of the shortcuts I use frequently. In the following shortcuts, <leader> represents ASCII character ,.

If you come across an issue, you can first use :checkhealth command provided by nvim to trouble-shoot yourself. Please read carefully the messages provided by health check.

If you still have an issue, open a new issue.

Some of the resources that I find helpful in mastering Vim is documented here. You may also be interested in my post in configuring Vim on different platforms:

• Config nvim on Linux for Python development
• Nvim config on Windows 10
• Nvim-qt config on Windows 10

1: Not enabled by default for Linux, see this issue on how to enable vimtex on Linux. ↩