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: .github/ISSUE_TEMPLATE/bug_report.md
+9-2Lines changed: 9 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,13 @@ assignees: ''
9
9
10
10
<!-- Any bug report not following this template will be immediately closed. Thanks -->
11
11
12
+
## Before Reporting an Issue
13
+
- I have read the kickstart.nvim README.md.
14
+
- I have read the appropriate plugin's documentation.
15
+
- I have searched that this issue has not been reported before.
16
+
17
+
-[ ]**By checking this, I confirm that the above steps are completed. I understand leaving this unchecked will result in this report being closed immediately.**
18
+
12
19
## Describe the bug
13
20
<!-- A clear and concise description of what the bug is. -->
14
21
@@ -18,8 +25,8 @@ assignees: ''
18
25
19
26
## Desktop
20
27
<!-- please complete the following information. -->
21
-
- OS:
22
-
- Terminal:
28
+
- OS:
29
+
- Terminal:
23
30
24
31
## Neovim Version
25
32
<!-- Output of running `:version` from inside of neovim. -->
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
85
-
current plugin status.
86
-
87
-
Read through the `init.lua` file in your configuration folder for more
88
-
information about extending and exploring Neovim.
89
-
90
-
### Getting Started
106
+
the current plugin status. Hit `q` to close the window.
91
107
92
-
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
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 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>
108
+
#### Read The Friendly Documentation
109
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
Read through the `init.lua` file in your configuration folder for more
111
+
information about extending and exploring Neovim. That also includes
112
+
examples of adding popularly requested plugins.
137
113
138
-
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).
114
+
> [!NOTE]
115
+
> For more information about a particular plugin check its repository's documentation.
139
116
140
-
In the file: `lua/custom/plugins/filetree.lua`, add:
141
117
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
-
```
118
+
### Getting Started
159
119
160
-
</details>
120
+
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
161
121
162
122
### FAQ
163
123
164
-
* What should I do if I already have a pre-existing neovim configuration?
124
+
* What should I do if I already have a pre-existing Neovim configuration?
165
125
* 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/`
126
+
* This includes your existing init.lua and the Neovim files in `~/.local`
127
+
which can be deleted with `rm -rf ~/.local/share/nvim/`
167
128
* 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:
129
+
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
130
+
to maintain multiple configurations. For example, you can install the kickstart
131
+
configuration in `~/.config/nvim-kickstart` and create an alias:
169
132
```
170
133
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
171
134
```
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.
135
+
When you run Neovim using `nvim-kickstart` alias it will use the alternative
136
+
config directory and the matching local directory
137
+
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
138
+
distribution that you would like to try out.
173
139
* What if I want to "uninstall" this configuration:
174
-
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
140
+
* See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information
175
141
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
176
142
* The main purpose of kickstart is to serve as a teaching tool and a reference
177
143
configuration that someone can easily use to `git clone` as a basis for their own.
178
144
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
145
+
into smaller parts. A fork of kickstart that does this while maintaining the
0 commit comments