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
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
83
-
current plugin status.
104
+
current plugin status. Hit `q` to close the window.
84
105
85
106
Read through the `init.lua` file in your configuration folder for more
86
-
information about extending and exploring Neovim.
87
-
88
-
### Getting Started
89
-
90
-
See [Effective Neovim: Instant IDE](https://youtu.be/stqUbv-5u2s), covering the
91
-
previous version. Note: The install via init.lua is outdated, please follow the
92
-
install instructions in this file instead. An updated video is coming soon.
93
-
94
-
### Recommended Steps
95
-
96
-
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
97
-
(so that you have your own copy that you can modify) and then installing you
98
-
can install to your machine using the methods above.
99
-
100
-
> **NOTE**
101
-
> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
102
-
103
-
#### Examples of adding popularly requested plugins
104
-
105
-
NOTE: You'll need to uncomment the line in the init.lua that turns on loading custom plugins.
106
-
107
-
<details>
108
-
<summary>Adding autopairs</summary>
109
-
110
-
This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) and enable it on startup. For more information, see documentation for [lazy.nvim](https://github.com/folke/lazy.nvim).
111
-
112
-
In the file: `lua/custom/plugins/autopairs.lua`, add:
113
-
114
-
```lua
115
-
-- File: lua/custom/plugins/autopairs.lua
116
-
117
-
return {
118
-
"windwp/nvim-autopairs",
119
-
-- Optional dependency
120
-
dependencies= { 'hrsh7th/nvim-cmp' },
121
-
config=function()
122
-
require("nvim-autopairs").setup {}
123
-
-- If you want to automatically add `(` after selecting a function or method
This will install the tree plugin and add the command `:Neotree` for you. You can explore the documentation at [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim) for more information.
107
+
information about extending and exploring Neovim. That also includes
108
+
examples of adding popularly requested plugins.
139
109
140
-
In the file: `lua/custom/plugins/filetree.lua`, add:
141
110
142
-
```lua
143
-
-- Unless you are still migrating, remove the deprecated commands from v1.x
144
-
vim.cmd([[ let g:neo_tree_remove_legacy_commands = 1 ]])
145
-
146
-
return {
147
-
"nvim-neo-tree/neo-tree.nvim",
148
-
version="*",
149
-
dependencies= {
150
-
"nvim-lua/plenary.nvim",
151
-
"nvim-tree/nvim-web-devicons", -- not strictly required, but recommended
152
-
"MunifTanjim/nui.nvim",
153
-
},
154
-
config=function ()
155
-
require('neo-tree').setup {}
156
-
end,
157
-
}
158
-
```
111
+
### Getting Started
159
112
160
-
</details>
113
+
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
161
114
162
115
### FAQ
163
116
164
117
* What should I do if I already have a pre-existing neovim configuration?
165
-
* You should back it up, then delete all files associated with it.
166
-
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
118
+
* You should back it up and then delete all associated files.
119
+
* This includes your existing init.lua and the neovim files in `~/.local`
120
+
which can be deleted with `rm -rf ~/.local/share/nvim/`
167
121
* Can I keep my existing configuration in parallel to kickstart?
168
-
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example you can install the kickstart configuration in `~/.config/nvim-kickstart` and create an alias:
122
+
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
123
+
to maintain multiple configurations. For example, you can install the kickstart
124
+
configuration in `~/.config/nvim-kickstart` and create an alias:
169
125
```
170
126
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
171
127
```
172
-
When you run Neovim using `nvim-kickstart` alias it will use the alternative config directory and the matching local directory `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim distribution that you would like to try out.
128
+
When you run Neovim using `nvim-kickstart` alias it will use the alternative
129
+
config directory and the matching local directory
130
+
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
131
+
distribution that you would like to try out.
173
132
* What if I want to "uninstall" this configuration:
174
133
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
175
134
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
176
135
* The main purpose of kickstart is to serve as a teaching tool and a reference
177
-
configuration that someone can easily `git clone` as a basis for their own.
136
+
configuration that someone can easily use to `git clone` as a basis for their own.
178
137
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
179
-
into smaller parts. A fork of kickstart that does this while maintaining the exact
138
+
into smaller parts. A fork of kickstart that does this while maintaining the
0 commit comments