*LazyVim.txt* For Neovim >= 0.8.0 Last change: 2023 January 24
==============================================================================
Table of Contents *LazyVim-table-of-contents*
- Features |LazyVim-features|
- Requirements |LazyVim-requirements|
- Getting Started |LazyVim-getting-started|
- File Structure |LazyVim-file-structure|
- Configuration |LazyVim-configuration|
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 *LazyVim-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 *LazyVim-requirements*
- Neovim >= **0.8.0** (needs to be built with **LuaJIT**)
- Git >= **2.19.0** (for partial clones support)
- a Nerd Font **_(optional)_**
GETTING STARTED *LazyVim-getting-started*
You can find a starter template for **LazyVim** here
Try it with Docker
>sh
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:
>sh
mv ~/.config/nvim ~/.config/nvim.bak
mv ~/.local/share/nvim ~/.local/share/nvim.bak
<
- Clone the starter
>sh
git clone https://github.com/LazyVim/starter ~/.config/nvim
<
- Remove the `.git` folder, so you can add it to your own repo later
>sh
rm -rf ~/.config/nvim/.git
<
- Start Neovim!
>sh
nvim
<
Refer to the comments in the files on how to customize **LazyVim**.
FILE STRUCTURE *LazyVim-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.toml
CONFIGURATION *LazyVim-configuration*
Refer to the docs
Generated by panvimdoc
vim:tw=78:ts=8:noet:ft=help:norl: