🗿 Essential.nvim

More than Kickstart less than LazyVim. All Essential plugins, options, autocmds, and keymaps (some from the great Vimeagen) with no extra bs for web devs

⭐ Features

• Transform your Neovim into an IDE with essentials only

• Easily customize and extend your config with Essential.nvim

• Blazingly fast

• Sane default settings for options, autocmds, and keymaps

• It's good 😁👍

⚡️ Requirements

• Neovim >= 0.9.0

• Git >= 2.19.0 (for partial clones support)

• a Nerd Font (optional)

• a C compiler for nvim-treesitter. See here

🛠️ Installation

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Install the Essential Starter

• Make a backup of your current Neovim files:

  # required
  mv ~/.config/nvim{,.bak}
  
  # optional but recommended
  mv ~/.local/share/nvim{,.bak}
  mv ~/.local/state/nvim{,.bak}
  mv ~/.cache/nvim{,.bak}

• Clone the starter

  git clone https://github.com/Harish-Khandre/essential.nvim ~/.config/nvim

• Remove the .git folder, so you can add it to your repo later

  rm -rf ~/.config/nvim/.git

• Start Neovim!

  nvim

  Refer to the comments in the files on how to customize Essential.

Install the Essential Starter with PowerShell

• Make a backup of your current Neovim files:

  # required
  Move-Item $env:LOCALAPPDATA\nvim $env:LOCALAPPDATA\nvim.bak
  
  # optional but recommended
  Move-Item $env:LOCALAPPDATA\nvim-data $env:LOCALAPPDATA\nvim-data.bak

• Clone the starter

  git clone https://github.com/Harish-Khandre/essential.nvim $env:LOCALAPPDATA\nvim

• Remove the .git folder, so you can add it to your repo later

  Remove-Item $env:LOCALAPPDATA\nvim\.git -Recurse -Force

• Start Neovim!

  nvim

:::tip

It is recommended to run :checkhealth after installation

:::