neoh1/nvim-kickstart

A launch point for your personal nvim configuration // some personal edits -N

kickstart.nvim

Introduction

Read FAQ at bottom first.

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

This fork contains only personal installation edits in readme.

NOTE Backup your previous configuration (if any exists) ~/.config/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.

External dependencies

sudo add-apt-repository ppa:neovim-ppa/stable -y # try /nightly if experiencing issues
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim

Clone kickstart.nvim from official repository (not mine)

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

Optional: NerdFont

1. Download a suitable font https://www.nerdfonts.com/font-downloads e.g. JetBrainsMonoNerdFont
2. Copy the font files to e.g. see below, update font-cache for system recognition

cp *.ttf ~/.local/share/fonts/
fc-cache -fv
fc-list | grep "JetBrainsMonoNerdFont" #  if font installed, path to the font listed

• 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.

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. That also includes examples of adding popularly requested plugins.

Getting Started

Youtube tutorial: The Only Video You Need to Get Started with Neovim

FAQ

• 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 with rm -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:

    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.

• 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 splitting init.lua into smaller parts. A fork of kickstart that does this while maintaining the same 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