Yet another NeoVim config

• This setup is inspired from multiple sources like:

  • kickstart project
  • LazyVim
  • The Primeagen init.lua
  • vmarlier dotfiles
  • grepm11n
  • bshephar kickstart

• Check docs folder for different tips & tricks.

Installation

External Dependencies

• 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

• Language Setup:

  • If you want to write Golang, you will need go

• Changes to lazy-lock.json are also tracked. Check more info here.

Installing on Ubuntu

• Using the script located in scripts directory or these commands

  sudo apt update
  sudo apt install make gcc unzip git xclip curl cargo luarocks fd-find python3-pip python3-neo python3-yamlfix shellcheck
  sudo snap install ripgrep --classic
  
  # Now we install nvim
  cd /tmp
  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
  cd -
  # make it available in /usr/local/bin, distro installs to /usr/bin
  sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/

FAQ

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

• How to "uninstall" this repository

  • See lazy.nvim uninstall information

  • Or once you removed ~/.config/nvim clean these up:

    rm -rf ~/.local/share/nvim
    rm -rf ~/.local/state/nvim
    rm -rf ~/.cache/nvim