This repo hosts our NeoVim configuration for Linux (with NixOS support), macOS, and Windows. init.lua
is the config entry point.
Branch info:
Branch | Supported neovim version |
---|---|
0.10 | nvim 0.10 nightly |
main | nvim 0.9 stable |
0.8 | nvim 0.8 |
0.7 | nvim 0.7 |
We currently manage plugins using lazy.nvim.
Chinese introduction is here.
- Fast. Less than 30ms to start (Depends on SSD and CPU, tested on Zephyrus G14 2022 version).
- Simple. Run out of the box.
- Modern. Pure
lua
config. - Modular. Easy to customize.
- Powerful. Full functionality to code.
Just run the following interactive bootstrap command, and you're good to go 👍
- Windows (Note: This script REQUIRES
pwsh
>v7.1
)
Set-ExecutionPolicy Bypass -Scope Process -Force; Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/scripts/install.ps1'))
- *nix
if command -v curl >/dev/null 2>&1; then
bash -c "$(curl -fsSL https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/scripts/install.sh)"
else
bash -c "$(wget -O- https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/scripts/install.sh)"
fi
It's strongly recommended to read Wiki: Prerequisites before starting, especially for *nix users.
See Wiki: Keybindings for details
See Wiki: Plugins for details
(You can also find a deps diagram there!)
See Wiki: Usage for details
See Wiki: NixOS Support for details
See Wiki: FAQ for details
Tested with rhysd/vim-startuptime
Lazygit with built-in Terminal
- If you find anything that needs improving, do not hesitate to point it out or create a PR.
- If you come across an issue, you can first use
:checkhealth
command provided by nvim to trouble-shoot yourself.- If you still have such problems, feel free to open a new issue!
This NeoVim configuration is released under the MIT license, which grants the following permissions:
- Commercial use
- Distribution
- Modification
- Private use
For more convoluted language, see the LICENSE.