A neovim configuration based on kickstart that is mostly unchanged:
- Small
- Single-file
- Completely Documented
Kickstart.nvim targets only the latest 'stable' and latest 'nightly' of Neovim. If you are experiencing issues, please make sure you have the latest versions.
External Requirements:
- Basic utils:
git
,make
,unzip
, C Compiler (gcc
) - ripgrep
- Clipboard tool (xclip/xsel/win32yank or other depending on platform)
- A Nerd Font: optional, provides various icons
- if you have it set
vim.g.have_nerd_font
ininit.lua
to true
- if you have it set
- Language Setup:
- If want to write Typescript, you need
npm
- If want to write Golang, you will need
go
- etc.
- If want to write Typescript, you need
- 'nnn' file manager
NOTE Backup your previous configuration (if any exists)
Neovim's configurations are located under the following paths:
$XDG_CONFIG_HOME/nvim
, ~/.config/nvim
Linux and Mac
git clone https://github.com/Norodix/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
Start Neovim
nvim
That's it! Lazy will install all the plugins you have. Use :Lazy
to view
current plugin status. Hit q
to close the window.
Read through the init.lua
file in your configuration folder for more
information about extending and exploring Neovim. That also includes
examples of adding popularly requested plugins.
- What should I do if I already have a pre-existing neovim configuration?
- You should back it up and then delete all associated files.
- This includes your existing init.lua and the neovim files in
~/.local
which can be deleted withrm -rf ~/.local/share/nvim/
- Can I keep my existing configuration in parallel to kickstart?
- Yes! You can use NVIM_APPNAME
=nvim-NAME
to maintain multiple configurations. For example, you can install the kickstart configuration in~/.config/nvim-kickstart
and create an alias:When you run Neovim usingalias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
nvim-kickstart
alias it will use the alternative config directory and the matching local directory~/.local/share/nvim-kickstart
. You can apply this approach to any Neovim distribution that you would like to try out.
- Yes! You can use NVIM_APPNAME
- What if I want to "uninstall" this configuration:
- See lazy.nvim uninstall information
- Why is the kickstart
init.lua
a single file? Wouldn't it make sense to split it into multiple files?- The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to
git clone
as a basis for their own. As you progress in learning Neovim and Lua, you might consider splittinginit.lua
into smaller parts. A fork of kickstart that does this while maintaining the same functionality is available here: - Discussions on this topic can be found here:
- The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to
Ubuntu Install Steps
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
Debian Install Steps
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl
# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
sudo rm -rf /opt/nvim-linux64
sudo mkdir -p /opt/nvim-linux64
sudo chmod a+rX /opt/nvim-linux64
sudo tar -C /opt -xzf nvim-linux64.tar.gz
# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
Fedora Install Steps
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
Arch Install Steps
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim