An opinionated but robust Neovim configuration used across most of my project.

A customizable personal Neovim config that is:

• Small
• Single-file
• Completely Documented

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

Project in display is go-relaychat.

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:

• 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
  • if you have it set vim.g.have_nerd_font in init.lua to true
• An ImageMagick installation for image preview in Nvim. For magick binding, it will be handled by this plugin so we don't have to install luarocks by ourselves.
  • Ubuntu: sudo apt install libmagickwand-dev
  • MacOS: brew install imagemagick
    • By default, brew installs into a weird location, so you have to add $(brew --prefix)/lib to DYLD_LIBRARY_PATH by adding something like export DYLD_LIBRARY_PATH="$(brew --prefix)/lib:$DYLD_LIBRARY_PATH" to your shell profile (probably .zshrc or .bashrc)
  • Fedora: sudo dnf install ImageMagick-devel
  • Arch: sudo pacman -Syu imagemagick
• Language Setup:
  • If you want to write Typescript, you need npm
  • If you want to write Golang, you will need go
  • etc.
• Silicon to generate a beautiful image of your code. Go to nvim-silicon using find feature and change the configuration accordingly! (NOTE: It contains my personal font and watermark, so don't forget to change!)
  • cargo install silicon

NOTE > For Arch/Cachy, just install from pacman with sudo pacman -S silicon

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:

If you're planning to build your own Neovim config, 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//kickstart.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 nvim-lua with in the commands below

Start Neovim

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

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