2023-02-17 21:31:57 +00:00
|
|
|
# kickstart.nvim
|
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
## Introduction
|
2022-06-24 03:35:53 +00:00
|
|
|
|
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
|
2024-02-26 15:03:53 +00:00
|
|
|
* Single-file
|
|
|
|
* Completely Documented
|
|
|
|
|
|
|
|
**NOT** a Neovim distribution, but instead a starting point for your configuration.
|
2022-06-24 03:35:53 +00:00
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
## Installation
|
2022-06-24 03:35:53 +00:00
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
### Install Neovim
|
2023-04-24 21:21:53 +00:00
|
|
|
|
2024-02-26 15:03:53 +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
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
### Install External Dependencies
|
2022-11-09 15:27:08 +00:00
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
External Requirements:
|
|
|
|
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
|
|
|
|
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
|
2024-03-06 16:49:44 +00:00
|
|
|
- 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
|
2024-02-26 15:03:53 +00:00
|
|
|
- Language Setup:
|
|
|
|
- If want to write Typescript, you need `npm`
|
|
|
|
- If want to write Golang, you will need `go`
|
|
|
|
- etc.
|
|
|
|
|
|
|
|
> **NOTE**
|
2024-03-17 20:22:58 +00:00
|
|
|
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
|
|
|
|
> and quick install snippets
|
2023-09-05 12:12:56 +00:00
|
|
|
|
2024-04-01 14:36:32 +00:00
|
|
|
### Install Kickstart
|
|
|
|
|
|
|
|
> **NOTE**
|
|
|
|
> [Backup](#FAQ) your previous configuration (if any exists)
|
|
|
|
|
2023-09-05 12:12:56 +00:00
|
|
|
Neovim's configurations are located under the following paths, depending on your OS:
|
|
|
|
|
|
|
|
| OS | PATH |
|
|
|
|
| :- | :--- |
|
2024-02-26 15:03:53 +00:00
|
|
|
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
|
2023-11-03 12:47:30 +00:00
|
|
|
| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
|
|
|
|
| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
|
2023-09-05 12:12:56 +00:00
|
|
|
|
2024-03-20 18:27:18 +00:00
|
|
|
#### Recommended Step
|
|
|
|
|
2024-03-21 19:47:55 +00:00
|
|
|
[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.
|
|
|
|
|
2024-03-20 18:27:18 +00:00
|
|
|
> **NOTE**
|
2024-03-21 19:47:55 +00:00
|
|
|
> Your fork's url will be something like this:
|
|
|
|
> `https://github.com/<your_github_username>/kickstart.nvim.git`
|
2024-03-20 18:27:18 +00:00
|
|
|
|
|
|
|
#### Clone kickstart.nvim
|
|
|
|
> **NOTE**
|
2024-03-21 19:47:55 +00:00
|
|
|
> If following the recommended step above (i.e., forking the repo), replace
|
|
|
|
> `nvim-lua` with `<your_github_username>` in the commands below
|
2023-09-05 12:12:56 +00:00
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
<details><summary> Linux and Mac </summary>
|
|
|
|
|
2023-11-30 00:34:43 +00:00
|
|
|
```sh
|
2023-09-07 16:36:05 +00:00
|
|
|
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
|
2023-10-01 00:06:22 +00:00
|
|
|
```
|
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
</details>
|
|
|
|
|
|
|
|
<details><summary> Windows </summary>
|
|
|
|
|
|
|
|
If you're using `cmd.exe`:
|
|
|
|
|
2023-11-30 00:34:43 +00:00
|
|
|
```
|
2024-03-04 13:47:11 +00:00
|
|
|
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
|
2023-09-05 12:12:56 +00:00
|
|
|
```
|
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
If you're using `powershell.exe`
|
|
|
|
|
2023-11-30 00:34:43 +00:00
|
|
|
```
|
2024-03-04 13:47:11 +00:00
|
|
|
git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
|
2023-11-03 12:47:30 +00:00
|
|
|
```
|
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
</details>
|
2023-11-03 12:47:30 +00:00
|
|
|
|
2023-09-05 12:12:56 +00:00
|
|
|
### Post Installation
|
|
|
|
|
2023-10-25 19:46:24 +00:00
|
|
|
Start Neovim
|
|
|
|
|
|
|
|
```sh
|
|
|
|
nvim
|
|
|
|
```
|
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
|
2024-03-27 15:22:28 +00:00
|
|
|
current plugin status. Hit `q` to close the window.
|
2023-10-25 19:46:24 +00:00
|
|
|
|
2024-02-26 15:03:53 +00:00
|
|
|
Read through the `init.lua` file in your configuration folder for more
|
2024-04-17 19:25:54 +00:00
|
|
|
information about extending and exploring Neovim. That includes also
|
|
|
|
examples of adding popularly requested plugins.
|
2023-09-05 12:12:56 +00:00
|
|
|
|
2022-12-20 18:27:01 +00:00
|
|
|
|
2024-03-20 18:27:18 +00:00
|
|
|
### Getting Started
|
|
|
|
|
|
|
|
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
|
|
|
|
|
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?
|
2024-03-08 20:26:32 +00:00
|
|
|
* You should back it up and then delete all associated files.
|
2024-03-21 19:47:55 +00:00
|
|
|
* This includes your existing init.lua and the neovim files in `~/.local`
|
|
|
|
which can be deleted with `rm -rf ~/.local/share/nvim/`
|
2023-10-28 21:33:10 +00:00
|
|
|
* Can I keep my existing configuration in parallel to kickstart?
|
2024-03-21 19:47:55 +00:00
|
|
|
* 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:
|
2023-10-28 21:33:10 +00:00
|
|
|
```
|
2023-11-30 22:30:55 +00:00
|
|
|
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
|
2023-10-28 21:33:10 +00:00
|
|
|
```
|
2024-03-21 19:47:55 +00:00
|
|
|
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.
|
2023-02-17 21:31:57 +00:00
|
|
|
* What if I want to "uninstall" this configuration:
|
|
|
|
* See [lazy.nvim uninstall](https://github.com/folke/lazy.nvim#-uninstalling) information
|
2023-11-03 18:04:25 +00:00
|
|
|
* 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
|
2024-03-08 20:26:32 +00:00
|
|
|
configuration that someone can easily use to `git clone` as a basis for their own.
|
2023-11-03 18:04:25 +00:00
|
|
|
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
|
2024-03-08 20:26:32 +00:00
|
|
|
into smaller parts. A fork of kickstart that does this while maintaining the
|
2023-11-03 18:04:25 +00:00
|
|
|
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/nvim-lua/kickstart.nvim/issues/218)
|
|
|
|
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
|
2023-02-17 21:31:57 +00:00
|
|
|
|
2024-03-17 20:22:58 +00:00
|
|
|
### Install Recipes
|
2023-02-17 21:31:57 +00:00
|
|
|
|
2024-03-17 20:22:58 +00:00
|
|
|
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>
|
2024-03-08 20:26:32 +00:00
|
|
|
Installation may require installing build tools and updating the run command for `telescope-fzf-native`
|
2023-02-17 21:31:57 +00:00
|
|
|
|
2023-04-13 13:34:27 +00:00
|
|
|
See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)
|
2023-02-17 21:31:57 +00:00
|
|
|
|
|
|
|
This requires:
|
|
|
|
|
2024-03-08 20:26:32 +00:00
|
|
|
- Install CMake and the Microsoft C++ Build Tools on Windows
|
2023-02-17 21:31:57 +00:00
|
|
|
|
|
|
|
```lua
|
2023-02-19 20:32:15 +00:00
|
|
|
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
|
2023-02-17 21:31:57 +00:00
|
|
|
```
|
2024-03-17 20:22:58 +00:00
|
|
|
</details>
|
|
|
|
<details><summary>Windows with gcc/make using chocolatey</summary>
|
2024-03-08 20:26:32 +00:00
|
|
|
Alternatively, one can install gcc and make which don't require changing the config,
|
2024-03-03 02:12:55 +00:00
|
|
|
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
|
2024-03-08 20:26:32 +00:00
|
|
|
open a new one so that choco path is set, and run in cmd as **admin**:
|
2024-03-03 02:12:55 +00:00
|
|
|
```
|
|
|
|
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
|
|
|
|
```
|
2024-03-17 20:22:58 +00:00
|
|
|
</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
|
2024-04-08 20:13:22 +00:00
|
|
|
sudo apt install make gcc ripgrep unzip git neovim
|
2024-03-17 20:22:58 +00:00
|
|
|
```
|
|
|
|
</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>
|
|
|
|
|
|
|
|
```
|
2024-04-16 15:29:27 +00:00
|
|
|
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
|
2024-03-17 20:22:58 +00:00
|
|
|
```
|
|
|
|
</details>
|
2024-03-03 02:12:55 +00:00
|
|
|
|