mroot/lazyvim
1
0
Fork 0
mirror of https://github.com/LazyVim/LazyVim.git synced 2026-07-25 14:01:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Neovim config for the lazy
906 commits 27 branches 345 tags 9.9 MiB
Find a file
Aron Griffis fdd5fa28ed fix(keymaps): line number toggling when only one option is set 
The previous code would blindly toggle both number and relativenumber
settings, even if one was set and the other wasn't. Instead, save the
respective values when toggling off, and restore when toggling on.
2023-07-20 14:43:04 -04:00
.github chore: update templates 2023-03-19 20:40:58 +01:00
doc chore(build): auto-generate vimdoc 2023-07-20 07:21:08 +00:00
lua/lazyvim fix(keymaps): line number toggling when only one option is set 2023-07-20 14:43:04 -04:00
.gitignore ci: templates 2023-01-04 21:56:53 +01:00
.neoconf.json build: neoconf sumneko_lua => lua_ls 2023-03-04 10:41:52 +01:00
CHANGELOG.md docs: Update CHANGELOG.md (#1160) 2023-07-18 20:45:24 +02:00
init.lua feat(init)!: disable init.lua and show a message on how to use LazyVim 2023-01-07 11:44:40 +01:00
LICENSE docs: added LICENSE 2023-01-01 09:48:09 +01:00
README-CN.md docs: added c compiler to requirements (#1082) 2023-07-12 17:36:30 +02:00
README-DE.md.txt docs: Added german Translation of the README (#136) 2023-01-27 08:13:30 +01:00
README.md docs: added c compiler to requirements 2023-06-23 13:20:03 +02:00
stylua.toml feat: initial commit 2022-12-30 17:30:52 +01:00

README.md

Install · Configure · Docs

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.

image

image

✨ 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.8.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
  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!

    nvim

    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

~/.config/nvim
├── lua
│   ├── config
│   │   ├── autocmds.lua
│   │   ├── keymaps.lua
│   │   ├── lazy.lua
│   │   └── options.lua
│   └── plugins
│       ├── spec1.lua
│       ├── **
│       └── spec2.lua
└── init.lua

⚙️ Configuration

Refer to the docs