Lightweight configuration focused on providing "basic features" with little boilerplate. It includes better syntax highlight, a fuzzy finder and IDE-like features powered by Neovim's LSP client.

• Neovim v0.5.1 or greater.
  • v0.11 is recommended
• git.
• tree-sitter CLI.
• A C compiler. Can be gcc, tcc or zig.
• A language server. Required to actually enable the "IDE-like" features.
• (optional) ripgrep. Improves project wide search speed.
• (optional) fd. Improves file search speed.

If you need a C compiler then zig is the easiest to install. It's available on winget, scoop and chocolatey. You can also find some links in the zig download page.

• I recommend installing Neovim's latest stable version.

• Backup your existing configuration if you have one.

• Create an init.lua file in your system.

  If you don't know the location of Neovim's configuration file use this command.

  nvim --headless -c 'echo stdpath("config") . "/init.lua" . "\n"' -c 'quit'

  Use whatever method you want to create the config folder and also an empty init.lua file.

• Choose a configuration file from the configs directory and copy its content to your own init.lua.

  • configs/stable.lua requires NVIM v0.11 or greater
  • configs/nightly.lua targets NVIM v0.12, the current nightly version

  You can check Neovim's version using this command.

  nvim --version

  If you need support for older Neovim versions:

  • configs/v0-9.lua targets NVIM v0.10 and v0.9
  • configs/v0-7.lua targets NVIM v0.8 and v0.7
  • configs/v0-5.lua targets NVIM v0.6 and v0.5

• Open Neovim, use the command nvim in your terminal. When Neovim starts all plugins will be downloaded automatically.

Neovim comes with an interactive tutorial that teaches the basics of the editor. The estimated time of this tutorial is around 45 minutes. It will show you how to move around text, how to execute commands and of course how to quit Neovim. You can access the tutorial by executing this command in your terminal.

nvim +Tutor

I've also created a documentation site aimed at teaching the basic features of Neovim. Note that it is mostly about how to use Neovim as a text editor without plugins, but there is still some valuable information there:

• The nvim command
• Basic editing
• Edit multiple files
• The help page

This configuration was created using a scripting language called lua, I highly recommend that you learn the syntax of this language. Learn just enough to know what is valid. Here are a couple resources:

• An Introduction to lua
• Learn X in Y minutes: Where X = lua
• Lua crash course (12min video)

Next step is to get familiar with Neovim's lua api, so you can create your own keybindings and commands. Here are a couple of guides you can read:

• Build your first Neovim configuration in lua
• Neovim's official lua guide

They are external programs that provide IDE-like features to Neovim. If you want to know more about language servers watch this wonderful 5 minutes video: LSP explained.

To know what language servers are supported you need to go to nvim-lspconfig's documentation, in configs.md you'll find links and instruction on how to install them.

Once you have a language server available in your system you need to enable it. Here's an example using the language server for lua, lua_ls.

On Neovim v0.10 or lower you must use the "legacy setup" function.

require('lspconfig').lua_ls.setup({})

On Neovim v0.11 or greater you can use the function vim.lsp.enable().

vim.lsp.enable('lua_ls')

To get a more accurate syntax highlight for your favorite language you need to download something called a "treesitter parser".

So inside this configuration there is a variable called ts_parsers, and initially it looks like this.

local ts_parsers = {'lua', 'vim', 'vimdoc', 'c', 'query'}

That will be a list of parsers, and they will be installed automatically. You can add more languages to this list, but make sure is supported by the plugin nvim-treesitter.

I've left a link to nvim-treesitter's documentation inside each configuration file. That will take you to the list of supported languages of the version that will be installed.

Another way to see the list of supported languages is by using tab-completion in Neovim's command-line mode. In Neovim, enter command-line mode by typing :, write TSInstall, press space, and then press the tab key. Neovim will show you the completion menu with all the available parsers. Note that on Neovim v0.11 and greater treesitter features must be enabled manually, so even if you install a parser with the command :TSInstall that parser should be added to the variable ts_parsers.

Neovim versions below v0.11 will use mini.deps as the plugin manager. Make sure to read the documentation to learn how to add more plugins:

• mini.deps overview

Neovim v0.12 and greater will use vim.pack, a builtin plugin manager currently under development.

• vim.pack official documentation.
• A Guide to vim.pack

Leader key: Space.