You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32Lines changed: 32 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,43 @@ Kickstart targets *only* the latest stable neovim release (0.7) and the nightly.
12
12
This repo is meant to be used as a starting point for a user's own configuration; remove the things you don't use and add what you miss. This configuration serves as the reference configuration for the [lspconfig wiki](https://github.com/neovim/nvim-lspconfig/wiki).
13
13
14
14
### Installation
15
+
15
16
* Backup your previous configuration
16
17
* Copy and paste the kickstart.nvim `init.lua` into `$HOME/.config/nvim/init.lua`
17
18
* start neovim (`nvim`) and run `:PackerInstall`, ignore any error message about missing plugins, `:PackerInstall` will fix that shortly.
18
19
* restart neovim
19
20
21
+
### Configuration
22
+
23
+
You could directly modify the `init.lua` file with your personal customizations. This option is the most straightforward, but if you update your config from this repo, you may need to reapply your changes.
24
+
25
+
An alternative approach is to create a separate `custom.plugins` module to register your own plugins. In addition, you can handle further customizations in a `after/plugin/defaults.lua` file. See the following examples for more information. Leveraging these files should make upgrading to a newer version of this repo easier.
26
+
27
+
#### Example `plugins.lua`
28
+
29
+
The following is an example of a `plugins.lua` file (located at `$HOME/.config/nvim/lua/custom/plugins.lua`) where you can register you own plugins.
30
+
31
+
```lua
32
+
returnfunction(use)
33
+
use({
34
+
"folke/which-key.nvim",
35
+
config=function()
36
+
require("which-key").setup({})
37
+
end
38
+
})
39
+
end
40
+
```
41
+
42
+
#### Example `defaults.lua`
43
+
44
+
The following is an example `defaults.lua` file (localed at `$HOME/.config/nvim/after/plugin/defaults.lua`) where you can define your own options, keymaps, autogroups, and more.
Pull-requests are welcome. The goal of this repo is not to create a neovim configuration framework, but to offer a starting template that shows, by example, available features in neovim. Some things that will not be included:
0 commit comments