Neovim configuration

A minimal Neovim configuration written in lua

Table of contents

• 1. Introduction
• 2. Installation
• 3. File structure
• 4. Plugins & LSP
  • 4.1. Plugins
  • 4.2. LSP
• 5. Keymaps
• 6. Customization
• 7. Screenshots
• 8. Contribution
• 9. Guide and resources

1. Introduction

Neovim is a pretty cool successor to Vim, focusing on compatibility while adding asynchronous plugin functionality and trying to clean up the code base. Having been fed up at various times with both Sublime Text (2 and 3) and Atom, and after realizing how much development I do over SSH, it seemed reasonable to check out using vim (or nvim, in this case) as my IDE. The advantages essentially boil down to:

• Consistent IDE over SSH or locally,
• No need to ever use the mouse while coding (takes longer to learn, but is faster; this is aided by vim-easymotion and Ctrl-Space),
• It’s been around forever, and frankly, probably always will be.

Therefore, I decided to create this repository. There are several versions:

• v0.1.0: written in VimL, a single file only.
• v0.1.1: written in VimL, consist of multiple files.
• v0.2.0: started from this version, switch from VimL to Lua. For the reason, you may to check neovim's official wiki. Follow KISS principle, this version uses the least plugins as possible. It's more like a skeleton, users can add more plugins and LSP.
• v0.2.1: this version contains some minor changes.
• v0.3.0: I decide to switch to lazy.nvim as my plugin manager, instead of packer. The main reason is lazy.nvim's support for plugin structure.

As I mentioned, this config is meant as a starting point, it is not a complete Neovim/Vim config distribution, if you're looking for a one, check out here.

2. Installation

• Requirements:
  • Install neovim >= 0.8.0, or you can build it yourself.
  • git >= 2.19.0 (for partial clones support)
  • fd and ripgrep.
  • I recommend using a nerdfonts (optional)
• Backup your current neovim config, if necessary:

mv ~/.config/nvim ~/.config/nvim.bak

• Neovim's configurations are located under the following paths, depending on your OS:

OS	PATH
Linux, MacOS	$XDG_CONFIG_HOME/nvim, ~/.config/nvim
Windows (cmd)	%localappdata%\nvim\
Windows (powershell)	$env:LOCALAPPDATA\nvim\

• Fork this repo so that you have your own copy that you can modify, then install by cloning the fork to your machine using one of the commands below, depending on your OS.

NOTE Your fork's url will be something like this: https://github.com/<your_github_username>/neovim-config.git

• Get your configuration:

NOTE If following the recommended step above (i.e., forking the repo), replace ntk148v with <your_github_username> in the commands below

Linux and Mac

git clone https://github.com/ntk148v/neovim-config.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim

Windows

If you're using cmd.exe:

git clone https://github.com/ntk148v/neovim-config.git "%localappdata%\nvim"

If you're using powershell.exe

git clone https://github.com/ntk148v/neovim-config.git "${env:LOCALAPPDATA}\nvim"

• Start Neovim, Lazy should be installed automatically, then it will install plugins.

nvim

3. File structure

The files under config will be automatically loaded at the appropriate time, so you don't need to require those files manually.

tree ~/.config/nvim
├── init.lua
├── lazy-lock.json
└── lua
    ├── config
    │   ├── autocmds.lua
    │   ├── custom
    │   │   └── init.lua
    │   ├── init.lua
    │   ├── keymaps.lua
    │   └── options.lua
    └── plugins
        ├── autopairs.lua
        ├── colorizer.lua
        ├── colorscheme.lua
        ├── comment.lua
        ├── custom
        │   ├── colorscheme.lua
        │   └── lush.lua
        ├── gitsigns.lua
        ├── lsp.lua
        ├── lualine.lua
        ├── toggleterm.lua
        ├── telescope.lua
        ├── tree.lua
        └── treesitter.lua

4. Plugins & LSP

4.1. Plugins

Plugin	Description
lazy.nvim	A modern plugin manager for Neovim
mason.nvim	Portable package manager for Neovim that runs everywhere Neovim runs. Easily install and manage LSP servers, DAP servers, linters, and formatters.
nvim-lspconfig	A collection of common configurations for Neovim's built-in language server client
gitsigns	Super fast git decorations implemented purely in lua/teal
nvim-treesitter	Nvim Treesitter configurations and abstraction layer
nvim-cmp	Auto completion plugin
LuaSnip	Snippet Engine for Neovim written in Lua
nvim-tree.lua -	A File Explorer written In Lua
nvim-autopairs	A super powerful autopairs for Neovim
nvim-web-devicons	Lua fork of vim-web-devicons for neovim
lualine.nvim	A blazing fast and easy to configure neovim statusline plugin written in pure lua.
Comment.nvim	Smart and powerful comment plugin for neovim. Supports treesitter, dot repeat, left-right/up-down motions, hooks, and more
norcalli/nvim-colorizer.lua	The fastest Neovim colorizer.
nvim-telescope/telescope.nvim	Find, Filter, Preview, Pick. All lua, all the time.
akinsho/toggleterm.nvim	A neovim lua plugin to help easily manage multiple terminal windows window
rosé-pine	Soho vibes for Neovim
folke/tokyonight.nvim	A clean, dark Neovim theme written in Lua, with support for lsp, treesitter and lots of plugins. Includes additional themes for Kitty, Alacritty, iTerm and Fish.
projekt0n/github-nvim-theme	Github's Neovim themes
nvimtools/none-ls.nvim	null-ls.nvim reloaded / Use Neovim as a language server to inject LSP diagnostics, code actions, and more via Lua.

4.2. LSP

This configuration provides Python and Golang dev environment. The programming language server is current supported:

• lua - builtin.
• python - ruff_lsp
• golang - gopls
• docker - dockerls
• bash - bashls
• vim - vimls
• yaml - yamlls
• json - jsonls

Furthermore, it integrates with nvim-treesitter to provide rich syntax highlighting and other language parsing magic.

If your language is not supported, please follow this:

• Check if LSP support is available in the lspconfig repo. To install a supported language server with mason:

:LspInstall `<your_language_server>`

• Check if your syntax is supported in the treesitter repo. To install a language syntax highlight, run:

:TSInstall `<language_to_install>`

5. Keymaps

These are the default keymaps, in the following shortcuts, the <leader>+` key is set up to `` (space) character, check: keymaps.lua.

Shortcut	Mode	Description
kk	Insert	Esc with kk
<leader>+r	Normal	Reload configuration file
<leader>+s	Normal	Save file
<leader>+q	Normal	Save (close all windows) and exit from Neovim
<leader>+tt	Normal	Open terminal
<leader>+n	Normal	Open NvimTree
<leader>+nr	Normal	Refresh NvimTree
<leader>+nf	Normal	Find file in NvimTree
<leader>+ff	Normal	Open Telescope to find files
<leader>+fg	Normal	Open Telescope to do live grep
<leader>+fb	Normal	Open Telescope to list buffers
<leader>+fh	Normal	Open Telescope to show help
<leader>+wh/j/k/l	Normal	Move around splits
mm	Normal	Comment/Uncomment line
mbm	Normal	Comment/Uncomment block
m	Visual	Comment/Uncomment line
mb	Visual	Comment/Uncomment block

There are many default keymaps, you can check it using :map command. There are also other variants:

• :nmap for normal mode mappings
• :vmap for visual mode mappings
• :imap for insert mode mappings

The above list is not complete. Typing :help map in Vim will give you more info.

6. Customization

• You can add your custom plugin specs under lua/plugins/custom. All files will be automatically loaded by lazy.nvim.
• You can also add your custom keymaps/options under lua/config/custom.

7. Screenshots

8. Contribution

Feel free to file an issue or open a pull request. You're welcome!

9. Guide and resources

• nanotee/nvim-lua-guide
• brainfucksec/neovim-lua
• LunarVim/Neovim-from-scratch
• LunarVim/nvim-basic-ide