Repository files navigation

A starting point for Neovim that is:

• Small
• Single-file
• Completely Documented

NOT a Neovim distribution, but instead a starting point for your configuration.

Kickstart.nvim targetsonly 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,fd-find
• Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
• ANerd Font: optional, provides various icons
  • if you have it setvim.g.have_nerd_font ininit.lua to true
• Emoji fonts (Ubuntu only, and only if you want emoji!)sudo apt install fonts-noto-color-emoji
• Language Setup:
  • If you want to write Typescript, you neednpm
  • If you want to write Golang, you will needgo
  • etc.

Neovim's configurations are located under the following paths, depending on your OS:

Fork this reposo that you have your own copy that you can modify, then install by cloning thefork to your machine using one of the commands below, depending on your OS.

You likely want to removelazy-lock.json from your fork's.gitignore filetoo - it's ignored in the kickstart repo to make maintenance easier, but it'srecommended to track it in version control.

git clone https://github.com/nvim-lua/kickstart.nvim.git"${XDG_CONFIG_HOME:-$HOME/.config}"/nvim

git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim"

git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"

Start Neovim

nvim

That's it! Lazy will install all the plugins you have. Use:Lazy to viewthe current plugin status. Hitq to close the window.

Read through theinit.lua file in your configuration folder for moreinformation about extending and exploring Neovim. That also includesexamples of adding popularly requested plugins.

The Only Video You Need to Get Started with Neovim

• 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~/.localwhich can be deleted withrm -rf ~/.local/share/nvim/
• Can I keep my existing configuration in parallel to kickstart?
  • Yes! You can useNVIM_APPNAME=nvim-NAMEto maintain multiple configurations. For example, you can install the kickstartconfiguration in~/.config/nvim-kickstart and create an alias:

    alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'

    When you run Neovim usingnvim-kickstart alias it will use the alternativeconfig directory and the matching local directory~/.local/share/nvim-kickstart. You can apply this approach to any Neovimdistribution that you would like to try out.
• What if I want to "uninstall" this configuration:
  • Seelazy.nvim uninstall information
• Why is the kickstartinit.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 referenceconfiguration that someone can easily use togit clone as a basis for their own.As you progress in learning Neovim and Lua, you might consider splittinginit.luainto smaller parts. A fork of kickstart that does this while maintaining thesame functionality is available here:
    • kickstart-modular.nvim
  • Discussions on this topic can be found here:
    • Restructure the configuration
    • Reorganize init.lua into a multi-file setup

Below you can find OS specific install instructions for Neovim and dependencies.

After installing all the dependencies continue with theInstall Kickstart step.

{'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 --installwslsudo add-apt-repository ppa:neovim-ppa/unstable -ysudo apt updatesudo apt install make gcc ripgrep unzip git xclip neovim

sudo add-apt-repository ppa:neovim-ppa/unstable -ysudo apt updatesudo apt install make gcc ripgrep unzip git xclip neovim

sudo apt updatesudo apt install make gcc ripgrep unzip git xclip curl# Now we install nvimcurl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gzsudo rm -rf /opt/nvim-linux-x86_64sudo mkdir -p /opt/nvim-linux-x86_64sudo chmod a+rX /opt/nvim-linux-x86_64sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz# make it available in /usr/local/bin, distro installs to /usr/binsudo ln -sf /opt/nvim-linux-x86_64/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