1. Introduction
2. Prerequisites
3. Structure
4. Plugins
5. Keybindings
6. Issues
7. Credit
8. TODO

This is my neovim's configuration, which contains four branch.

I use packer.nvim to manage plugins.

Chinese introduction is here.

Pros:

• Fast. Less than 50ms to start(Depends on SSD, tested on Sumsung 970 evo).
• Simple. Run out of the box.
• Modern. Pure lua to config.
• Modular. Easy to customize.
• Powerful. Full functionality to code.

(Tested with rhysd/vim-startuptime)

1. Neovim base installation for archlinux

# gitui required by tui git operations
# ripgrep required by telescope word search engine
# ripgrep required by telescope-zoxide
# sqlite required by telescope-frecency
# fd required by telescope file search engine
# yarn required by markdown preview
# nerd-fonts-ibm-plex-mono required by devicons
sudo pacman -S git gitui zoxide ripgrep sqlite fd yarn nerd-fonts-ibm-plex-mono

# nodejs, neovim-git required by copilot.
# neovim version >= 0.6
yay -S nodejs neovim-git

# for neovim python module
pip install neovim --user

# clone
git clone https://github.com/ayamir/nvimdots ~/.config/nvim

# sync plugins(maybe need multiple times)
nvim +PackerSync

2. Recommended Terminals:

   alacritty, kitty, wezterm

sudo pacman -S alacritty kitty wezterm

3. Recommended GUI applications:

   neovide, goneovim

paru neovide
paru goneovim

4. Tools for plugins

• For nvim-lsp-installer, you need to install corresponding language server use it.

The default html server has bug which does not support embeded javascript completion. So you need to install another server manually.

npm i -g vscode-html-languageserver-bin

• For nvim-treesitter, all maintained parser will be installed by default.

• For format.nvim, you need to install corresponding formatter manually:

# clangformat for c/cpp etc
sudo pacman -S clang
# gofmt and goimports for golang
go get -u golang.org/x/tools/...
# lua-format for lua
paru -S lua-format-git
# yapf and autopep8 for python
pip install autopep8 yapf --user
# rustfmt
sudo pacman -S rustup
# on the stable toolchain
rustup component add rustfmt
# on the nightly toolchain
rustup component add rustfmt --toolchain nightly
# prettier for markdown/html etc
sudo pacman -S prettier
# jq for json
sudo pacman -S jq
# shfmt for shell
sudo pacman -S shfmt

init.lua is the kernel config file. It requires configuration in lua directory.

• lua directory contains 3 parts.

  • core directory contains base configuration of neovim.

  • keymap directory contains keybindings of plugins.

  • modules directory contains 5 parts.

    • completion directory contains code completion's configuration.

    • editor directory contains plugins' configuration about editing.

    • lang directory contains plugins' configuration about specific language.

    • tools directory contains telescope and its extensions' configuration.

    • ui directory contains plugins' configuration about ui.

• Add plugin

  1. Determine this plugin belongs to what kind(completion, editor, lang, tools, ui).

  2. Add a list item in corresponding plugins.lua.

     For example, I want to add rmagatti/auto-session to editor category.

     Then I need to modify lua/modules/editor/plugins.lua:

     

     (You should learn how to use packer.nvim install and configure plugin on your own)

     I also need to modify lua/modules/editor/config.lua:

     

     Then press <leader>ps:

     

     Then try its command: SaveSession

     

     Then restart nvim and execute RestoreSession.

     

     So this plugin is added successfully!

• Remove plugin

  1. Determine this plugin belongs to what kind(completion, editor, lang, tools, ui).

  2. Remove its config located in corresponding plugins.lua and config.lua.

  3. Remove corresponding keymap if exists.

  4. Press <leader>ps to recompile.

• Modify keymap

  • For vanilla nvim's keymap

    modify lua/core/mapping.lua

  • For specific plugin's keymap

    modify lua/keymap/init.lua

• Modify event defined by autocmd

  modify lua/core/event.lua

• Modify vanilla nvim's options

  modify lua/core/options.lua

• Switch light/dark theme(if you use edge theme)

# To light
    sed -i "s/\=dark/\=light/g" ~/.config/nvim/lua/modules/ui/config.lua
    sed -i "s/onedark/onelight/g" ~/.config/nvim/lua/modules/ui/config.lua
    nvim +PackerSync
# To Dark
    sed -i "s/\=light/\=dark/g" ~/.config/nvim/lua/modules/ui/config.lua
    sed -i "s/onelight/onedark/g" ~/.config/nvim/lua/modules/ui/config.lua
    nvim +PackerSync

You need to execute PackerSync or just press <leader>ps to compile the latest config if you modify the any config in lua directory.

Don't worry if you meet any error for your new config.

The old compiled file called bak_compiled.lua is located in $HOME/.local/share/nvim/site/lua directory.

If you just want to restore to old config:

cd $HOME/.local/share/nvim/site/lua
cp ./bak_compiled.lua ./_compiled.lua

Then you can figure out what modification makes error.

The leader key is ,.

You can see more keybinds in lua/core/mapping.lua and lua/keymap/init.lua.

1. Clipboard for WSL2 users

Please refer to it and add win32yank.exe to your path.

Then uncomment this line.

2. Wrong configuration may invoke the dialog asking for deleting all plugins

Input n and <CR>

3. LSP servers don't autostart.

Please check this to make sure your directory can be detected as a working directory.

For example (gopls):

Your root directory need a go.mod and your .go file need to be created first. Then LSP will autostart when you edit .go file next time.

4. Copilot setup.

Make sure your github account is signed up for copilot.

Then use Copilot setup command to setup.

• glepnir/nvim as my config organization template.

• More documentation for how to customize.
• Backup old compiled configuration when error occurs.