|
|
|
|
@ -1,59 +1,91 @@
|
|
|
|
|
# kickstart.nvim
|
|
|
|
|
|
|
|
|
|
https://github.com/kdheepak/kickstart.nvim/assets/1813121/f3ff9a2b-c31f-44df-a4fa-8a0d7b17cf7b
|
|
|
|
|
|
|
|
|
|
### Introduction
|
|
|
|
|
## Introduction
|
|
|
|
|
|
|
|
|
|
A starting point for Neovim that is:
|
|
|
|
|
|
|
|
|
|
* Small
|
|
|
|
|
* Single-file (with examples of moving to multi-file)
|
|
|
|
|
* Documented
|
|
|
|
|
* Modular
|
|
|
|
|
* Single-file
|
|
|
|
|
* Completely Documented
|
|
|
|
|
|
|
|
|
|
This repo is meant to be used by **YOU** to begin your Neovim journey; remove the things you don't use and add what you miss.
|
|
|
|
|
**NOT** a Neovim distribution, but instead a starting point for your configuration.
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
Distribution Alternatives:
|
|
|
|
|
- [LazyVim](https://www.lazyvim.org/): A delightful distribution maintained by @folke (the author of lazy.nvim, the package manager used here)
|
|
|
|
|
### Install Neovim
|
|
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
> **NOTE**
|
|
|
|
|
### Install External Dependencies
|
|
|
|
|
|
|
|
|
|
External Requirements:
|
|
|
|
|
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
|
|
|
|
|
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
|
|
|
|
|
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
|
|
|
|
|
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
|
|
|
|
|
- Language Setup:
|
|
|
|
|
- If want to write Typescript, you need `npm`
|
|
|
|
|
- If want to write Golang, you will need `go`
|
|
|
|
|
- etc.
|
|
|
|
|
|
|
|
|
|
> **NOTE**
|
|
|
|
|
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
|
|
|
|
|
> and quick install snippets
|
|
|
|
|
|
|
|
|
|
### Install Kickstart
|
|
|
|
|
|
|
|
|
|
> **NOTE**
|
|
|
|
|
> [Backup](#FAQ) your previous configuration (if any exists)
|
|
|
|
|
|
|
|
|
|
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 [Windows Installation](#Windows-Installation) if you have trouble with `telescope-fzf-native`
|
|
|
|
|
|
|
|
|
|
Neovim's configurations are located under the following paths, depending on your OS:
|
|
|
|
|
|
|
|
|
|
| OS | PATH |
|
|
|
|
|
| :- | :--- |
|
|
|
|
|
| Linux | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
|
|
|
|
|
| MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
|
|
|
|
|
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
|
|
|
|
|
| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
|
|
|
|
|
| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
|
|
|
|
|
|
|
|
|
|
clone --branch lolmc kickstart.nvim:
|
|
|
|
|
#### Recommended Step
|
|
|
|
|
|
|
|
|
|
[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.
|
|
|
|
|
|
|
|
|
|
> **NOTE**
|
|
|
|
|
> Your fork's url will be something like this:
|
|
|
|
|
> `https://github.com/<your_github_username>/kickstart.nvim.git`
|
|
|
|
|
|
|
|
|
|
#### Clone kickstart.nvim
|
|
|
|
|
> **NOTE**
|
|
|
|
|
> If following the recommended step above (i.e., forking the repo), replace
|
|
|
|
|
> `lolmc` with `<your_github_username>` in the commands below
|
|
|
|
|
|
|
|
|
|
<details><summary> Linux and Mac </summary>
|
|
|
|
|
|
|
|
|
|
- on Linux and Mac
|
|
|
|
|
```sh
|
|
|
|
|
git clone --branch lolmc https://github.com/lolmc/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
|
|
|
|
|
git clone https://github.com/lolmc/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
- on Windows (cmd)
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
<details><summary> Windows </summary>
|
|
|
|
|
|
|
|
|
|
If you're using `cmd.exe`:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
git clone --branch lolmc https://github.com/lolmc/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
|
|
|
|
|
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
- on Windows (powershell)
|
|
|
|
|
If you're using `powershell.exe`
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
git clone --branch lolmc https://github.com/lolmc/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
|
|
|
|
|
git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
### Post Installation
|
|
|
|
|
|
|
|
|
|
@ -63,33 +95,23 @@ Start Neovim
|
|
|
|
|
nvim
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The `Lazy` plugin manager will start automatically on the first run and install the configured plugins - as can be seen in the introduction video. After the installation is complete you can press `q` to close the `Lazy` UI and **you are ready to go**! Next time you run nvim `Lazy` will no longer show up.
|
|
|
|
|
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
|
|
|
|
|
current plugin status. Hit `q` to close the window.
|
|
|
|
|
|
|
|
|
|
If you would prefer to hide this step and run the plugin sync from the command line, you can use:
|
|
|
|
|
Read through the `init.lua` file in your configuration folder for more
|
|
|
|
|
information about extending and exploring Neovim.
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
nvim --headless "+Lazy! sync" +qa
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Recommended Steps
|
|
|
|
|
#### Examples of adding popularly requested plugins
|
|
|
|
|
|
|
|
|
|
[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) and then installing you can install to your machine using the methods above.
|
|
|
|
|
NOTE: You'll need to uncomment the line in the init.lua that turns on loading custom plugins.
|
|
|
|
|
|
|
|
|
|
> **NOTE**
|
|
|
|
|
> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
|
|
|
|
|
<details>
|
|
|
|
|
<summary>Adding autopairs</summary>
|
|
|
|
|
|
|
|
|
|
### Configuration And Extension
|
|
|
|
|
|
|
|
|
|
* Inside of your copy, feel free to modify any file you like! It's your copy!
|
|
|
|
|
* Feel free to change any of the default options in `init.lua` to better suit your needs.
|
|
|
|
|
* For adding plugins, there are 3 primary options:
|
|
|
|
|
* Add new configuration in `lua/custom/plugins/*` files, which will be auto sourced using `lazy.nvim` (uncomment the line importing the `custom/plugins` directory in the `init.lua` file to enable this)
|
|
|
|
|
* Modify `init.lua` with additional plugins.
|
|
|
|
|
* Include the `lua/kickstart/plugins/*` files in your configuration.
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
#### Example: Adding an autopairs plugin
|
|
|
|
|
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).
|
|
|
|
|
|
|
|
|
|
In the file: `lua/custom/plugins/autopairs.lua`, add:
|
|
|
|
|
|
|
|
|
|
@ -113,22 +135,24 @@ return {
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
<details>
|
|
|
|
|
<summary>Adding a file tree plugin</summary>
|
|
|
|
|
|
|
|
|
|
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).
|
|
|
|
|
|
|
|
|
|
#### Example: Adding a file tree plugin
|
|
|
|
|
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).
|
|
|
|
|
|
|
|
|
|
In the file: `lua/custom/plugins/filetree.lua`, add:
|
|
|
|
|
|
|
|
|
|
```lua
|
|
|
|
|
-- Unless you are still migrating, remove the deprecated commands from v1.x
|
|
|
|
|
vim.cmd([[ let g:neo_tree_remove_legacy_commands = 1 ]])
|
|
|
|
|
-- File: lua/custom/plugins/filetree.lua
|
|
|
|
|
|
|
|
|
|
return {
|
|
|
|
|
"nvim-neo-tree/neo-tree.nvim",
|
|
|
|
|
version = "*",
|
|
|
|
|
dependencies = {
|
|
|
|
|
"lolmc/plenary.nvim",
|
|
|
|
|
"nvim-lua/plenary.nvim",
|
|
|
|
|
"nvim-tree/nvim-web-devicons", -- not strictly required, but recommended
|
|
|
|
|
"MunifTanjim/nui.nvim",
|
|
|
|
|
},
|
|
|
|
|
@ -138,56 +162,121 @@ return {
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
### Contribution
|
|
|
|
|
### Getting Started
|
|
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
* 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.
|
|
|
|
|
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
|
|
|
|
|
|
|
|
|
|
### FAQ
|
|
|
|
|
|
|
|
|
|
* 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)
|
|
|
|
|
* You should back it up and then delete all associated files.
|
|
|
|
|
* This includes your existing init.lua and the neovim files in `~/.local`
|
|
|
|
|
which can be deleted with `rm -rf ~/.local/share/nvim/`
|
|
|
|
|
* Can I keep my existing configuration in parallel to kickstart?
|
|
|
|
|
* 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:
|
|
|
|
|
* 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:
|
|
|
|
|
```
|
|
|
|
|
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
|
|
|
|
|
```
|
|
|
|
|
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.
|
|
|
|
|
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.
|
|
|
|
|
* 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). Note the install via init.lua no longer works as specified. Please follow the install instructions in this file instead as they're up to date.
|
|
|
|
|
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
|
|
|
|
|
* The main purpose of kickstart is to serve as a teaching tool and a reference
|
|
|
|
|
configuration that someone can easily `git clone --branch lolmc` as a basis for their own.
|
|
|
|
|
configuration that someone can easily use to `git clone` as a basis for their own.
|
|
|
|
|
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
|
|
|
|
|
into smaller parts. A fork of kickstart that does this while maintaining the exact
|
|
|
|
|
into smaller parts. A fork of kickstart that does this while maintaining the
|
|
|
|
|
same functionality is available here:
|
|
|
|
|
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
|
|
|
|
|
* Discussions on this topic can be found here:
|
|
|
|
|
* [Restructure the configuration](https://github.com/lolmc/kickstart.nvim/issues/218)
|
|
|
|
|
* [Reorganize init.lua into a multi-file setup](https://github.com/lolmc/kickstart.nvim/pull/473)
|
|
|
|
|
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
|
|
|
|
|
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
|
|
|
|
|
|
|
|
|
|
### Windows Installation
|
|
|
|
|
### Install Recipes
|
|
|
|
|
|
|
|
|
|
Installation may require installing build tools, and updating the run command for `telescope-fzf-native`
|
|
|
|
|
Below you can find OS specific install instructions for Neovim and dependencies.
|
|
|
|
|
|
|
|
|
|
After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
|
|
|
|
|
|
|
|
|
|
#### Windows Installation
|
|
|
|
|
|
|
|
|
|
<details><summary>Windows with Microsoft C++ Build Tools and CMake</summary>
|
|
|
|
|
Installation may require installing build tools and updating the run command for `telescope-fzf-native`
|
|
|
|
|
|
|
|
|
|
See `telescope-fzf-native` documentation 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
|
|
|
|
|
- Install CMake and the Microsoft C++ Build Tools on Windows
|
|
|
|
|
|
|
|
|
|
```lua
|
|
|
|
|
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
|
|
|
|
|
```
|
|
|
|
|
</details>
|
|
|
|
|
<details><summary>Windows with gcc/make using chocolatey</summary>
|
|
|
|
|
Alternatively, one can install gcc and make which don't require changing the config,
|
|
|
|
|
the easiest way is to use choco:
|
|
|
|
|
|
|
|
|
|
1. install [chocolatey](https://chocolatey.org/install)
|
|
|
|
|
either follow the instructions on the page or use winget,
|
|
|
|
|
run in cmd as **admin**:
|
|
|
|
|
```
|
|
|
|
|
winget install --accept-source-agreements chocolatey.chocolatey
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
2. install all requirements using choco, exit previous cmd and
|
|
|
|
|
open a new one so that choco path is set, and run in cmd as **admin**:
|
|
|
|
|
```
|
|
|
|
|
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
|
|
|
|
|
```
|
|
|
|
|
</details>
|
|
|
|
|
<details><summary>WSL (Windows Subsystem for Linux)</summary>
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
wsl --install
|
|
|
|
|
wsl
|
|
|
|
|
sudo add-apt-repository ppa:neovim-ppa/unstable -y
|
|
|
|
|
sudo apt update
|
|
|
|
|
sudo apt install make gcc ripgrep unzip neovim
|
|
|
|
|
```
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
#### Linux Install
|
|
|
|
|
<details><summary>Ubuntu Install Steps</summary>
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo add-apt-repository ppa:neovim-ppa/unstable -y
|
|
|
|
|
sudo apt update
|
|
|
|
|
sudo apt install make gcc ripgrep unzip git neovim
|
|
|
|
|
```
|
|
|
|
|
</details>
|
|
|
|
|
<details><summary>Debian Install Steps</summary>
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo apt update
|
|
|
|
|
sudo apt install make gcc ripgrep unzip git
|
|
|
|
|
echo "deb https://deb.debian.org/debian unstable main" | sudo tee -a /etc/apt/sources.list
|
|
|
|
|
sudo apt update
|
|
|
|
|
sudo apt install -t unstable neovim
|
|
|
|
|
```
|
|
|
|
|
</details>
|
|
|
|
|
<details><summary>Fedora Install Steps</summary>
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
|
|
|
|
|
```
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
<details><summary>Arch Install Steps</summary>
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
|
|
|
|
|
```
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
|
Lol McBride
GitHub