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
+24-8Lines changed: 24 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -50,14 +50,20 @@ Neovim's configurations are located under the following paths, depending on your
50
50
51
51
#### Recommended Step
52
52
53
-
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo so that you have your own copy that you can modify, then install by cloning the fork to your machine using one of the commands below, depending on your OS.
53
+
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
54
+
so that you have your own copy that you can modify, then install by cloning the
55
+
fork to your machine using one of the commands below, depending on your OS.
56
+
57
+
54
58
55
59
> **NOTE**
56
-
> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
> If following the recommended step above (i.e., forking the repo), replace `nvim-lua` with `<your_github_username>` in the commands below
65
+
> If following the recommended step above (i.e., forking the repo), replace
66
+
> `nvim-lua` with `<your_github_username>` in the commands below
61
67
62
68
<details><summary> Linux and Mac </summary>
63
69
@@ -105,7 +111,9 @@ NOTE: You'll need to uncomment the line in the init.lua that turns on loading cu
105
111
<details>
106
112
<summary>Adding autopairs</summary>
107
113
108
-
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).
114
+
This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs)
115
+
and enable it on startup. For more information, see documentation for
116
+
[lazy.nvim](https://github.com/folke/lazy.nvim).
109
117
110
118
In the file: `lua/custom/plugins/autopairs.lua`, add:
111
119
@@ -133,7 +141,9 @@ return {
133
141
<details>
134
142
<summary>Adding a file tree plugin</summary>
135
143
136
-
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).
144
+
This will install the tree plugin and add the command `:Neotree` for you.
In the file: `lua/custom/plugins/filetree.lua`, add:
139
149
@@ -164,13 +174,19 @@ return {
164
174
165
175
* What should I do if I already have a pre-existing neovim configuration?
166
176
* You should back it up and then delete all associated files.
167
-
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
177
+
* This includes your existing init.lua and the neovim files in `~/.local`
178
+
which can be deleted with `rm -rf ~/.local/share/nvim/`
168
179
* Can I keep my existing configuration in parallel to kickstart?
169
-
* 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:
180
+
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
181
+
to maintain multiple configurations. For example, you can install the kickstart
182
+
configuration in `~/.config/nvim-kickstart` and create an alias:
170
183
```
171
184
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
172
185
```
173
-
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.
186
+
When you run Neovim using `nvim-kickstart` alias it will use the alternative
187
+
config directory and the matching local directory
188
+
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
189
+
distribution that you would like to try out.
174
190
* What if I want to "uninstall" this configuration:
175
191
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
176
192
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
0 commit comments