Table of contents

• 1. Introduction

• 2. Screenshots

• 3. Installation

• 4. File structure

• 5. Plugins & LSP

  • 5.1. Plugins
  • 5.2. LSP

• 6. Keymaps

• 7. Customization

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

2. Screenshots

3. Installation

• Requirements:
  • Install neovim >= 0.11.0, or you can build it yourself.
  • git >= 2.19.0 (for partial clones support)
  • fd and ripgrep.
  • treesitter-cli.
  • 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:

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

• Get your configuration:

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

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

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

• Restart Neovim and enjoy it.
• Keep updated: You should keep updated using git pull.

4. 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
    ├── autocmds.lua
    ├── custom.lua
    ├── mappings.lua
    ├── options.lua
    ├── plugins
    │   ├── configs
    │   │   ├── cmp.lua
    │   │   ├── gitsigns.lua
    │   │   ├── lspconfig.lua
    │   │   ├── lualine.lua
    │   │   ├── luasnip.lua
    │   │   ├── mason.lua
    │   │   ├── mini-files.lua
    │   │   ├── null-ls.lua
    │   │   └── treesitter.lua
    │   └── init.lua
    └── sample_custom.lua

5. Plugins & LSP

5.1. Plugins

5.2. LSP

By default, the follow LSP servers are installed and configured:

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

You can add more LSP servers and language syntax highlighting by editing the custom file.

6. Keymaps

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

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.

7. Customization

You can customize this configuration by creating the custom module. You can choose either two ways:

• Create ${XDG_CONFIG_HOME:-$HOME/.config}/nvim/lua/custom.lua file.
• Create module ${XDG_CONFIG_HOME:-$HOME/.config}/nvim/lua/custom/ if your custom configuration is too long, and you want to separate it into multiple files.

Checkout the sample custom file for the starting point. The logic is taken from CyberNvim. There are a number of defined sections in the config:

• M.setup_sources is used to add extra sources to connect to Null-ls - you can find a list of sources here. The parameter b is just short for null_ls.builtins.
• M.treesitter_parsers is used to add extra Treesitter highlighter. Actually, you don't need this, the current config will automatically detect file type and download the treesitter parser.
• M.plugins is where you will add your own plugin definitions.
• M.configs is the most important section of your own configuration. This is where you can define any autocommands, require any files, or otherwise completely port your current configuration.
• M.formatting_servers is used to setup auto formatting rules. You need to select the language server that will provide autoformatting capabilities

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

Copyright © 2022-present Kien Nguyen Tuan