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
* upstream/master: (46 commits)
Automatically set detached state as needed. (nvim-lua#925)
fix: debug.lua (nvim-lua#918)
Add diff to treesitter's ensure_installed languages (nvim-lua#908)
Move LspDetach handler near kickstart-lsp-highlight group (nvim-lua#900)
README: add clipboard tool dependency (nvim-lua#886)
Update README.md (nvim-lua#875)
fix: highlight group clear on each attach (nvim-lua#874)
Fix highlight errors when lsp crash or stop (nvim-lua#864)
Fix deprecation notice of inlay hints (nvim-lua#873)
Add a commented out example of the classic complete keymaps. Fixesnvim-lua#866 (nvim-lua#868)
Minor improvements of debian install instructions. Fixesnvim-lua#859 (nvim-lua#869)
Update README.md (nvim-lua#860)
fix: restore Mason config timing for DAP startup (again) (nvim-lua#865)
Add gitsigns recommended keymaps as an optional plugin (nvim-lua#858)
Move plugin examples from README to optional plugin files (nvim-lua#831)
Enable inlay hints for the supporting servers (nvim-lua#843)
Fix: nvim-lua#847 - add prefer_git to treesitter config (nvim-lua#856)
Comment about nerd font selection. Fixesnvim-lua#853 (nvim-lua#854)
Arch, btw (nvim-lua#852)
Update README (nvim-lua#832)
Add a pull request template (nvim-lua#825)
README: move backup and paths from external deps to install section (nvim-lua#819)
Don't lazy load conform plugin (nvim-lua#818)
Add a keymap space-f to format buffer using conform (nvim-lua#817)
Add instructions to quit :lazy. Fixesnvim-lua#761fixnvim-lua#799 (nvim-lua#800)
README: wrap long lines (nvim-lua#784)
Update README.md (nvim-lua#781)
Add nvim-nio as dependency for nvim-dap-ui (nvim-lua#774)
Some suggestions and capitalised a few words (nvim-lua#771)
...
> **NOTE**
> If following the recommended step above (i.e., forking the repo), replace
65
+
> `nvim-lua` with `<your_github_username>` in the commands below
51
66
52
67
<details><summary> Linux and Mac </summary>
53
68
@@ -82,94 +97,34 @@ nvim
82
97
```
83
98
84
99
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
85
-
current plugin status.
100
+
current plugin status. Hit `q` to close the window.
86
101
87
102
Read through the `init.lua` file in your configuration folder for more
88
-
information about extending and exploring Neovim.
103
+
information about extending and exploring Neovim. That also includes
104
+
examples of adding popularly requested plugins.
105
+
89
106
90
107
### Getting Started
91
108
92
109
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
93
110
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 install. You
98
-
can install it on 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. For more information, see the documentation at [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).
139
-
140
-
In the file: `lua/custom/plugins/filetree.lua`, add:
141
-
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
-
```
159
-
160
-
</details>
161
-
162
111
### FAQ
163
112
164
113
* What should I do if I already have a pre-existing neovim configuration?
165
114
* You should back it up and then delete all associated files.
166
-
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
115
+
* This includes your existing init.lua and the neovim files in `~/.local`
116
+
which can be deleted with `rm -rf ~/.local/share/nvim/`
167
117
* 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:
118
+
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
119
+
to maintain multiple configurations. For example, you can install the kickstart
120
+
configuration in `~/.config/nvim-kickstart` and create an alias:
169
121
```
170
122
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
171
123
```
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.
124
+
When you run Neovim using `nvim-kickstart` alias it will use the alternative
125
+
config directory and the matching local directory
126
+
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
127
+
distribution that you would like to try out.
173
128
* What if I want to "uninstall" this configuration:
174
129
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
175
130
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
@@ -183,8 +138,15 @@ return {
183
138
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
184
139
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
185
140
186
-
### Windows Installation
141
+
### Install Recipes
187
142
143
+
Below you can find OS specific install instructions for Neovim and dependencies.
144
+
145
+
After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
146
+
147
+
#### Windows Installation
148
+
149
+
<details><summary>Windows with Microsoft C++ Build Tools and CMake</summary>
188
150
Installation may require installing build tools and updating the run command for `telescope-fzf-native`
189
151
190
152
See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)
0 commit comments