Neovim config for the lazy

Primary LanguageLuaApache License 2.0Apache-2.0

Install ยท Configure ยท Docs

Latest release Last commit License Stars Issues Repo Size follow on Twitter

LazyVim is a Neovim setup powered by ๐Ÿ’ค lazy.nvim to make it easy to customize and extend your config. Rather than having to choose between starting from scratch or using a pre-made distro, LazyVim offers the best of both worlds - the flexibility to tweak your config as needed, along with the convenience of a pre-configured setup.



โœจ Features

  • ๐Ÿ”ฅ Transform your Neovim into a full-fledged IDE
  • ๐Ÿ’ค Easily customize and extend your config with lazy.nvim
  • ๐Ÿš€ Blazingly fast
  • ๐Ÿงน Sane default settings for options, autocmds, and keymaps
  • ๐Ÿ“ฆ Comes with a wealth of plugins pre-configured and ready to use

โšก๏ธ Requirements

  • Neovim >= 0.9.0 (needs to be built with LuaJIT)
  • Git >= 2.19.0 (for partial clones support)
  • a Nerd Font (optional)
  • a C compiler for nvim-treesitter. See here

๐Ÿš€ Getting Started

You can find a starter template for LazyVim here

Try it with Docker
docker run -w /root -it --rm alpine:edge sh -uelic '
  apk add git lazygit neovim ripgrep alpine-sdk --update
  git clone https://github.com/LazyVim/starter ~/.config/nvim
  cd ~/.config/nvim
Install the LazyVim Starter
  • Make a backup of your current Neovim files:

    mv ~/.config/nvim ~/.config/nvim.bak
    mv ~/.local/share/nvim ~/.local/share/nvim.bak
  • Clone the starter

    git clone https://github.com/LazyVim/starter ~/.config/nvim
  • Remove the .git folder, so you can add it to your own repo later

    rm -rf ~/.config/nvim/.git
  • Start Neovim!


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

There's a great video created by @elijahmanor with a walkthrough to get started.

Watch the video

๐Ÿ“‚ File Structure

The files under config will be automatically loaded at the appropriate time, so you don't need to require those files manually. LazyVim comes with a set of default config files that will be loaded before your own. See here

You can add your custom plugin specs under lua/plugins/. All files there will be automatically loaded by lazy.nvim

โ”œโ”€โ”€ lua
โ”‚   โ”œโ”€โ”€ config
โ”‚   โ”‚   โ”œโ”€โ”€ autocmds.lua
โ”‚   โ”‚   โ”œโ”€โ”€ keymaps.lua
โ”‚   โ”‚   โ”œโ”€โ”€ lazy.lua
โ”‚   โ”‚   โ””โ”€โ”€ options.lua
โ”‚   โ””โ”€โ”€ plugins
โ”‚       โ”œโ”€โ”€ spec1.lua
โ”‚       โ”œโ”€โ”€ **
โ”‚       โ””โ”€โ”€ spec2.lua
โ””โ”€โ”€ init.lua

โš™๏ธ Configuration

Refer to the docs