Skip to content

README.md

Latest commit

 

History

History
270 lines (187 loc) · 8.18 KB

README.md

File metadata and controls

270 lines (187 loc) · 8.18 KB

My personal fork of nvim-lua/kickstart.nvim

Introduction

Note

I only tested this fork on Linux. This will probably not work on other operating systems

A starting point for Neovim that is:

This contains a base of kickstart.nvim with extra features, such as:

  • LSPs linters and formatters for various languages
  • Debug adapters for various languages with some quality of life improvements
  • A bunch of extra plugins

Work in progress

This is still a work in progress, here are a few things that still need attention:

  • Update nvim-treesitter to branch main, as soon as it covers all the features used here
  • Split init.lua into a multi-file configuration

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

External Requirements:

  • Basic utils: git, make, unzip, C Compiler (gcc)
  • ripgrep, fd-find
  • Clipboard tool (wl-clipboard/xclip/xsel/win32yank or other depending on the platform)
  • A Nerd Font: optional, provides various icons
    • if you have it set vim.g.have_nerd_font in init.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 need npm
    • If you want to write Golang, you will need go
    • etc.

Install Kickstart

Note

Backup your previous configuration (if any exists)

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) %localappdata%\nvim\
Windows (powershell) $env:LOCALAPPDATA\nvim\

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/Razcoina/conf.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
Windows

If you're using cmd.exe:

git clone https://github.com/Razcoina/conf.nvim.git "%localappdata%\nvim"

If you're using powershell.exe

git clone https://github.com/Razcoina/conf.nvim.git "${env:LOCALAPPDATA}\nvim"

Post Installation

Start Neovim

nvim

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

Also use :Mason to check the installation progress of Mason packages.

Manual packages

Some packages refuse to behave when normally installed through Mason and should as such be installed manually. This configuration uses one such package:

  • local-lua-debugger-vscode to debug lua code.

To install this package, follow these instructions: (Linux only)

git clone https://github.com/tomblind/local-lua-debugger-vscode "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/manual/local-lua-debugger-vscode
cd "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/manual/local-lua-debugger-vscode
npm install
npm run build

After restarting Neovim, it should be ready to use.

Read The Friendly Documentation

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.

Note

For more information about a particular plugin check its repository's documentation.

Getting Started

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:

Install Recipes

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

After installing all the dependencies continue with the Install Kickstart step.

Windows Installation

Windows with Microsoft C++ Build Tools and CMake Installation may require installing build tools and updating the run command for `telescope-fzf-native`

See telescope-fzf-native documentation for more details

This requires:

  • Install CMake and the Microsoft C++ Build Tools on Windows
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
Windows with gcc/make using chocolatey Alternatively, one can install gcc and make which don't require changing the config, the easiest way is to use choco:
  1. install chocolatey either follow the instructions on the page or use winget, run in cmd as admin:
winget install --accept-source-agreements chocolatey.chocolatey
  1. install all requirements using choco, exit the previous cmd and open a new one so that choco path is set, and run in cmd as admin:
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
WSL (Windows Subsystem for Linux) 
wsl --install
wsl
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim

Linux Install

Ubuntu Install Steps 
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
Debian Install Steps 
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl

# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
sudo rm -rf /opt/nvim-linux-x86_64
sudo mkdir -p /opt/nvim-linux-x86_64
sudo chmod a+rX /opt/nvim-linux-x86_64
sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz

# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
Fedora Install Steps 
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
Arch Install Steps 
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim