kickstart.nvim

Note:: Forked from https://github.com/nvim-lua/kickstart.nvim

Installation

Install Neovim

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.

Install External Dependencies

NOTE Backup your previous configuration (if any exists)

External Requirements:

• Basic utils: git, make, unzip, C Compiler (gcc)
• ripgrep
• A Nerd Font: optional, provides various icons
  • if you have it set vim.g.have_nerd_font in init.lua to true
• Language Setup:
  • If want to write Typescript, you need npm
  • If want to write Golang, you will need go
  • etc.

NOTE See Install Recipes for additional Windows and Linux specific notes and quick install snippets

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)	%userprofile%\AppData\Local\nvim\
Windows (powershell)	$env:USERPROFILE\AppData\Local\nvim\

Install Kickstart

Recommended Step

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.nvim.git

Clone kickstart.nvim

NOTE If following the recommended step above (i.e., forking the repo), replace nvim-lua with <your_github_username> in the commands below

Linux and Mac

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

Windows

If you're using cmd.exe:

git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\

If you're using powershell.exe

git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\

Post Installation

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.