mirror/LazyVim.LazyVim
1
0
Fork 0
mirror of https://github.com/LazyVim/LazyVim.git synced 2025-06-22 00:49:03 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
Neovim config for the lazy https://lazyvim.github.io/
1275 commits 23 branches 318 tags 8.4 MiB
Find a file
Folke Lemaitre 98b51a608c
style(dashboard): make layout exactly the same as before
2023-10-19 07:52:47 +02:00
.github ci: LazyVim now requires Neovim >= 0.9.0 (#1751) 2023-10-16 10:41:54 +02:00
doc chore(build): auto-generate vimdoc 2023-10-19 05:45:44 +00:00
lua/lazyvim style(dashboard): make layout exactly the same as before 2023-10-19 07:52:47 +02:00
queries/lua feat(treesitter): map vim to @namespace.builtin 2023-10-03 20:17:33 +02: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 chore(main): release 10.4.4 (#1786) 2023-10-18 13:11:54 +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
NEWS.md feat(extras): LazyExtras can now manage user extras lua/plugins/extras. Fixes #1681 2023-10-12 21:47:31 +02:00
README-CN.md docs: LazyVim now requires Neovim >= 0.9.0 (#1548) 2023-10-01 21:01:40 +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!: LazyVim now requires Neovim >= 0.9.0 2023-10-01 14:01:12 +02:00
stylua.toml build(format): sort requires 2023-10-09 11:34:23 +02: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.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
  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