mirror of
https://github.com/Baipyrus/nvim-config.git
synced 2024-08-17 02:19:44 +00:00
3.0 KiB
3.0 KiB
Introduction
This project is a fork of dam9000/kickstart-modular.nvim
Installation (Windows Only)
NOTE Backup your previous configuration (if any exists)
Neovim's configurations are located under the following path:
Shell | PATH |
---|---|
cmd | %userprofile%\AppData\Local\nvim\ |
powershell | $env:USERPROFILE\AppData\Local\nvim\ |
-
Download and install:
NOTE In this case, using chocolatey is quick and easy
NOTE Make sure to select 'add to PATH' during installation
-
Clone this repository:
- on Windows (cmd)
git clone https://github.com/Baipyrus/nvim-config.git %userprofile%\AppData\Local\nvim\
- on Windows (powershell)
git clone https://github.com/Baipyrus/nvim-config.git $env:USERPROFILE\AppData\Local\nvim\
Post Installation
Start Neovim
nvim
The Lazy
plugin manager will start automatically on the first run and install the configured plugins. After the installation is complete you can press q
to close the Lazy
UI and you are ready to go! Next time you run nvim Lazy
will no longer show up.
If you would prefer to hide this step and run the plugin sync from the command line, you can use:
nvim --headless "+Lazy! sync" +qa
FAQ
- What should I do if I already have a pre-existing neovim configuration?
- You should back it up, then delete all files associated with it.
- This includes your existing init.lua and the neovim files in
%userprofile%\AppData\Local\nvim-data\
(CMD) or$env:USERPROFILE\AppData\Local\nvim-data\
(Powershell) which should be deleted afterwards. - You may also want to look at the migration guide for lazy.nvim
- What if I want to "uninstall" this configuration:
- See lazy.nvim uninstall information
- Why is the kickstart
init.lua
a single file? Wouldn't it make sense to split it into multiple files?- The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily
git clone
as a basis for their own. As you progress in learning Neovim and Lua, you might consider splittinginit.lua
into smaller parts. This is the fork of the original project that splits the configuration into smaller parts. The original repo that maintains the exact same functionality in a singleinit.lua
file is available here: - Discussions on this topic can be found here:
- The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily