Table of contents

• 1. Introduction
• 2. Installation
• 3. File structure
• 4. Plugins & LSP
  • 4.1. Plugins
  • 4.2. LSP
• 5. Keymaps
• 6. Screenshots
• 7. Contribution
• 8. 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 mutliple 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 suppot)
  • I recommend using a nerdfonts (optional)
• Backup your current neovim config, if necessary:

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

• Get your configuration:

git clone https://github.com/ntk148v/neovim-config.git
cd neovim-config.git/
cp -Rv nvim ~/.config/

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

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
    │   ├── init.lua
    │   ├── keymaps.lua
    │   └── options.lua
    └── plugins
        ├── autopairs.lua
        ├── colorizer.lua
        ├── colorscheme.lua
        ├── comment.lua
        ├── custom
        │   └── lush.lua
        ├── gitsigns.lua
        ├── lsp.lua
        ├── lualine.lua
        ├── neoterm.lua
        ├── telescope.lua
        ├── tree.lua
        └── treesitter.lua

4. Plugins & LSP

4.1. Plugins

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

4.2. LSP

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

• lua - builtin.
• python - pyright
• 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 avaiable 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 hightlight, 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.

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

7. Contribution

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

8. Guide and resources

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