This is a fork of nvim-lua/kickstart.nvim that moves from a single file to a multi file configuration.
A starting point for Neovim that is:
NOT a Neovim distribution, but instead a starting point for your configuration.
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:
git
, make
, unzip
, C Compiler (gcc
)vim.g.have_nerd_font
in init.lua
to truenpm
go
NOTE See Install Recipes for additional Windows and Linux specific notes and quick install snippets
NOTE Backup your previous configuration (if any exists)
Neovim's configurations are located under the following paths, depending on your OS:
OS | PATH |
---|---|
Linux, MacOS | $XDG_CONFIG_HOME/nvim , ~/.config/nvim |
Windows (cmd) | %localappdata%\nvim\ |
Windows (powershell) | $env:LOCALAPPDATA\nvim\ |
Fork this repo so that you have your own copy that you can modify, then install by cloning the fork to your machine using one of the commands below, depending on your OS.
NOTE Your fork's url will be something like this:
https://github.com/<your_github_username>/kickstart-modular.nvim.git
You likely want to remove lazy-lock.json
from your fork's .gitignore
file
too - it's ignored in the kickstart repo to make maintenance easier, but it's
recommmended to track it in version control.
NOTE If following the recommended step above (i.e., forking the repo), replace
dam9000
with<your_github_username>
in the commands below
git clone https://github.com/dam9000/kickstart-modular.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
If you're using cmd.exe
:
git clone https://github.com/dam9000/kickstart.nvim.git "%localappdata%\nvim"
If you're using powershell.exe
git clone https://github.com/dam9000/kickstart.nvim.git "${env:LOCALAPPDATA}\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.
The Only Video You Need to Get Started with Neovim
~/.local
which can be deleted with rm -rf ~/.local/share/nvim/
=nvim-NAME
to maintain multiple configurations. For example, you can install the kickstart
configuration in ~/.config/nvim-kickstart
and create an alias:alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
When you run Neovim using 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.init.lua
a single file? Wouldn't it make sense to split it into multiple files?git clone
as a basis for their own.
As you progress in learning Neovim and Lua, you might consider splitting init.lua
into smaller parts. A fork of kickstart that does this while maintaining the
same functionality is available here:
init.lua
file is available here:
Below you can find OS specific install instructions for Neovim and dependencies.
After installing all the dependencies continue with the Install Kickstart step.
See telescope-fzf-native
documentation for more details
This requires:
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
winget install --accept-source-agreements chocolatey.chocolatey
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
wsl --install
wsl
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
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/
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim