2023-02-17 21:31:57 +00:00
# kickstart.nvim
2022-06-24 03:35:53 +00:00
### Introduction
2022-11-09 15:27:08 +00:00
A starting point for Neovim that is:
2022-06-24 03:35:53 +00:00
2023-02-17 21:31:57 +00:00
* Small
* Single-file (with examples of moving to multi-file)
2022-06-24 03:35:53 +00:00
* Documented
* Modular
2023-02-17 21:31:57 +00:00
This repo is meant to be used as by **YOU** to begin your Neovim journey; remove the things you don't use and add what you miss.
2022-06-24 03:35:53 +00:00
2023-02-17 21:31:57 +00:00
Distribution Alternatives:
- [LazyVim ](https://www.lazyvim.org/ ): A delightful distribution maintained by @folke (the author of lazy.nvim, the package manager used here)
2022-06-24 03:35:53 +00:00
### Installation
2022-11-09 15:27:08 +00:00
2023-02-17 21:31:57 +00:00
Kickstart.nvim targets *only* the latest ['stable' ](https://github.com/neovim/neovim/releases/tag/stable ) and latest ['nightly' ](https://github.com/neovim/neovim/releases/tag/nightly ) of Neovim. If you are experiencing issues, please make sure you have the latest versions.
2022-06-24 03:35:53 +00:00
* Backup your previous configuration
2023-02-17 21:31:57 +00:00
* (Recommended) Fork this repo (so that you have your own copy that you can modify).
* Clone the kickstart repo into `$HOME/.config/nvim/` (Linux/Mac) or `~/AppData/Local/nvim/` (Windows)
* If you don't want to include it as a git repo, you can just clone it and then move the files to this location
* Start Neovim (`nvim`) and allow `lazy.nvim` to complete installation.
2022-11-09 15:27:08 +00:00
* Restart Neovim
2023-02-17 21:31:57 +00:00
* **You're ready to go!**
2022-06-24 03:35:53 +00:00
2023-02-17 21:31:57 +00:00
Additional system requirements:
- Make sure to review the readmes of the plugins if you are experiencing errors. In particular:
- [ripgrep ](https://github.com/BurntSushi/ripgrep#installation ) is required for multiple [telescope ](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies ) pickers.
- See as well [Windows Installation ](#Windows-Installation )
2022-12-20 18:27:01 +00:00
2023-02-17 21:31:57 +00:00
### Configuration And Extension
2022-12-19 22:56:21 +00:00
2023-02-17 21:31:57 +00:00
* Inside of your fork, feel free to modify any file you like! It's your fork!
* Then there are two primary configuration options available:
* Include the `lua/kickstart/plugins/*` files in your configuration.
* Add new configuration in `lua/custom/plugins/*` files, which will be auto sourced using `lazy.nvim`
* NOTE: To enable this, you need to uncomment `{ import = 'custom.plugins' }` in your `init.lua`
2022-12-22 12:45:20 +00:00
2023-02-17 21:31:57 +00:00
You can also merge updates/changes from the repo back into your fork, to keep up-to-date with any changes for the default configuration
2022-12-22 12:45:20 +00:00
2023-02-17 21:31:57 +00:00
#### Example: Adding an autopairs plugin
2022-12-22 12:45:20 +00:00
2023-02-17 21:31:57 +00:00
In the file: `lua/custom/plugins/autopairs.lua` , add:
2022-12-22 12:45:20 +00:00
```lua
2023-02-17 21:31:57 +00:00
-- File: lua/custom/plugins/autopairs.lua
return {
"windwp/nvim-autopairs",
config = function()
require("nvim-autopairs").setup {}
end,
}
2022-12-22 12:45:20 +00:00
```
2022-11-21 12:47:24 +00:00
2023-02-17 21:31:57 +00:00
This will automatically install `nvim-autopairs` and enable it on startup. For more information, see documentation for [lazy.nvim ](https://github.com/folke/lazy.nvim ).
2022-11-21 12:47:24 +00:00
2023-02-17 21:31:57 +00:00
#### Example: Adding a file tree plugin
2022-11-21 12:47:24 +00:00
2023-02-17 21:31:57 +00:00
In the file: `lua/custom/plugins/filetree.lua` , add:
2022-11-21 12:47:24 +00:00
```lua
2023-02-17 21:31:57 +00:00
return {
"nvim-neo-tree/neo-tree.nvim",
version = "*",
dependencies = {
"nvim-lua/plenary.nvim",
"nvim-tree/nvim-web-devicons", -- not strictly required, but recommended
"MunifTanjim/nui.nvim",
},
config = function ()
-- Unless you are still migrating, remove the deprecated commands from v1.x
vim.cmd([[ let g:neo_tree_remove_legacy_commands = 1 ]])
require('neo-tree').setup {}
end,
}
2022-11-21 12:47:24 +00:00
```
2023-02-17 21:31:57 +00:00
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.
#### Example: Adding a file to change default options
2022-11-21 12:47:24 +00:00
2023-02-17 21:31:57 +00:00
To change default options, you can add a file in the `/after/plugin/` folder (see `:help load-plugins` ) to include your own options, keymaps, autogroups, and more. The following is an example `defaults.lua` file (located at `$HOME/.config/nvim/after/plugin/defaults.lua` ).
2022-11-21 12:47:24 +00:00
```lua
vim.opt.relativenumber = true
vim.keymap.set('n', '< leader > sr', require('telescope.builtin').resume, { desc = '[S]earch [R]esume' })
```
2022-06-24 03:35:53 +00:00
### Contribution
2022-11-09 15:27:08 +00:00
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:
2022-06-24 03:35:53 +00:00
* Custom language server configuration (null-ls templates)
* Theming beyond a default colorscheme necessary for LSP highlight groups
Each PR, especially those which increase the line count, should have a description as to why the PR is necessary.
2022-12-20 18:27:01 +00:00
### FAQ
2023-02-17 21:31:57 +00:00
* What should I do if I already have a pre-existing neovim configuration?
* You should back it up, then delete all files associated with it.
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
* You may also want to look at the [migration guide for lazy.nvim ](https://github.com/folke/lazy.nvim#-migration-guide )
* What if I want to "uninstall" this configuration:
* See [lazy.nvim uninstall ](https://github.com/folke/lazy.nvim#-uninstalling ) information
* Are there any cool videos about this plugin?
* Current iteration of kickstart (coming soon)
* Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim ](https://youtu.be/stqUbv-5u2s ).
### Windows Installation
Installation may require installing build tools, and updating the run command for `telescope-fzf-native`
See `telescope-fzf-native` documention for [more details ](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation )
This requires:
- Install CMake, and the Microsoft C++ Build Tools on Windows
```lua
use {'nvim-telescope/telescope-fzf-native.nvim', run = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release & & cmake --build build --config Release & & cmake --install build --prefix build' }
```
2022-12-20 18:27:01 +00:00