mirror/LazyVim.LazyVim
1
0
Fork 0
mirror of https://github.com/LazyVim/LazyVim.git synced 2025-08-31 23:19:58 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
Neovim config for the lazy https://lazyvim.github.io/
1888 commits 23 branches 318 tags 8.7 MiB
Find a file
github-actions[bot] ad092e96f9
chore(main): release 12.8.0 (#3494) 
🤖 I have created a release *beep* *boop*
---


##
[12.8.0](https://github.com/LazyVim/LazyVim/compare/v12.7.0...v12.8.0)
(2024-06-06)


### Features

* **options:** added linebreak=true to default options
([1f4c196](1f4c1964fd))


### Bug Fixes

* **markdown:** missing markdown-toc in mason
([#3499](https://github.com/LazyVim/LazyVim/issues/3499))
([a9aea4b](a9aea4b5a1))
* **mason-nvim-dap:** correctly configure to auto-install debug adapters
([#3493](https://github.com/LazyVim/LazyVim/issues/3493))
([86ba1bc](86ba1bc62d))
* **octo:** fixed octo's rendering of comment signs when lines are
wrapped
([81370cf](81370cf714))
* **octo:** load octo on `octo://*` events, so that those buffers work
after session restore
([e6443ad](e6443ad7dc))
* **php:** php gets recommended in every .git repo
([#3496](https://github.com/LazyVim/LazyVim/issues/3496))
([3654098](3654098520))
* **prettier:** fix prettier config detection. Closes
[#3497](https://github.com/LazyVim/LazyVim/issues/3497)
([e51199c](e51199cffa))
* **prettier:** use prettier to check if prettier should run on the file
([0255b8f](0255b8fdb1))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2024-06-06 17:44:45 +02:00
.github ci: feature template 2024-06-05 23:11:06 +02:00
doc chore(build): auto-generate vimdoc 2024-06-06 04:10:32 +00:00
lua/lazyvim fix(prettier): use prettier to check if prettier should run on the file 2024-06-06 17:38:12 +02:00
queries/lua feat(lua): added LazyVim as a treesitter builtin 2024-05-15 15:31:08 +02:00
tests feat(extras): allow recommended to be the args for LazyVim.extras.wants 2024-06-05 23:35:14 +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 12.8.0 (#3494) 2024-06-06 17:44:45 +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(coding): use lazydev.nvim instead of neodev.nvim 2024-06-02 09:33:52 +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 docs: readme should be unix format. Fixes #3247 2024-05-20 00:13:18 +02:00
README-JP.md docs: Added Japanese Translation of the README (#2232) 2024-06-05 15:22:50 +02:00
README-KO.md docs: add the Korean version of README (#2495) 2024-06-05 15:22:30 +02:00
README-PT.md docs(pt): add readme in portuguese (#1958) 2024-06-05 15:23:09 +02:00
README.md docs!: LazyVim now requires Neovim >= 0.9.0 2023-10-01 14:01:12 +02:00
release-please-config.json ci: change the release please action name to new (#3259) 2024-06-05 14:49:33 +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