44
55A starting point for Neovim that is:
66
7- * Small
8- * Single-file
9- * Completely Documented
7+ - Small
8+ - Single-file
9+ - Completely Documented
1010
1111** NOT** a Neovim distribution, but instead a starting point for your configuration.
1212
1313## Installation
1414
1515### Install Neovim
1616
17- Kickstart.nvim targets * only * the latest
17+ Kickstart.nvim targets _ only _ the latest
1818[ 'stable'] ( https://github.com/neovim/neovim/releases/tag/stable ) and latest
1919[ 'nightly'] ( https://github.com/neovim/neovim/releases/tag/nightly ) of Neovim.
2020If you are experiencing issues, please make sure you have the latest versions.
2121
2222### Install External Dependencies
2323
2424External Requirements:
25+
2526- Basic utils: ` git ` , ` make ` , ` unzip ` , C Compiler (` gcc ` )
2627- [ ripgrep] ( https://github.com/BurntSushi/ripgrep#installation ) ,
2728 [ fd-find] ( https://github.com/sharkdp/fd#installation )
2829- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
2930- A [ Nerd Font] ( https://www.nerdfonts.com/ ) : optional, provides various icons
3031 - if you have it set ` vim.g.have_nerd_font ` in ` init.lua ` to true
31- - Emoji fonts (Ubuntu only, and only if you want emoji!) ` sudo apt install fonts-noto-color-emoji `
32+ - Emoji fonts (only if you want emoji!)
33+ - On Arch Linux: ` sudo pacman -S noto-fonts-emoji ` or ` yay -S noto-fonts-emoji `
34+ - On Ubuntu: ` sudo apt install fonts-noto-color-emoji `
3235- Language Setup:
3336 - If you want to write Typescript, you need ` npm `
3437 - If you want to write Golang, you will need ` go `
@@ -40,16 +43,15 @@ External Requirements:
4043
4144### Install Kickstart
4245
43- > [ !NOTE]
44- > [ Backup] ( #FAQ ) your previous configuration (if any exists)
46+ > [ !NOTE] > [ Backup] ( #FAQ ) your previous configuration (if any exists)
4547
4648Neovim's configurations are located under the following paths, depending on your OS:
4749
48- | OS | PATH |
49- | :- | :--- |
50- | Linux, MacOS | ` $XDG_CONFIG_HOME/nvim ` , ` ~/.config/nvim ` |
51- | Windows (cmd)| ` %localappdata%\nvim\ ` |
52- | Windows (powershell)| ` $env:LOCALAPPDATA\nvim\ ` |
50+ | OS | PATH |
51+ | :------------------- | :------------------------------------- --- |
52+ | Linux, MacOS | ` $XDG_CONFIG_HOME/nvim ` , ` ~/.config/nvim ` |
53+ | Windows (cmd) | ` %localappdata%\nvim\ ` |
54+ | Windows (powershell) | ` $env:LOCALAPPDATA\nvim\ ` |
5355
5456#### Recommended Step
5557
@@ -115,19 +117,18 @@ examples of adding popularly requested plugins.
115117> [ !NOTE]
116118> For more information about a particular plugin check its repository's documentation.
117119
118-
119120### Getting Started
120121
121122[ The Only Video You Need to Get Started with Neovim] ( https://youtu.be/m8C0Cq9Uv9o )
122123
123124### FAQ
124125
125- * What should I do if I already have a pre-existing Neovim configuration?
126- * You should back it up and then delete all associated files.
127- * This includes your existing init.lua and the Neovim files in ` ~/.local `
126+ - What should I do if I already have a pre-existing Neovim configuration?
127+ - You should back it up and then delete all associated files.
128+ - This includes your existing init.lua and the Neovim files in ` ~/.local `
128129 which can be deleted with ` rm -rf ~/.local/share/nvim/ `
129- * Can I keep my existing configuration in parallel to kickstart?
130- * Yes! You can use [ NVIM_APPNAME] ( https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME ) ` =nvim-NAME `
130+ - Can I keep my existing configuration in parallel to kickstart?
131+ - Yes! You can use [ NVIM_APPNAME] ( https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME ) ` =nvim-NAME `
131132 to maintain multiple configurations. For example, you can install the kickstart
132133 configuration in ` ~/.config/nvim-kickstart ` and create an alias:
133134 ```
@@ -137,18 +138,18 @@ examples of adding popularly requested plugins.
137138 config directory and the matching local directory
138139 `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
139140 distribution that you would like to try out.
140- * What if I want to "uninstall" this configuration:
141- * See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information
142- * Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
143- * The main purpose of kickstart is to serve as a teaching tool and a reference
141+ - What if I want to "uninstall" this configuration:
142+ - See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information
143+ - Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
144+ - The main purpose of kickstart is to serve as a teaching tool and a reference
144145 configuration that someone can easily use to `git clone` as a basis for their own.
145146 As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
146147 into smaller parts. A fork of kickstart that does this while maintaining the
147148 same functionality is available here:
148- * [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
149- * Discussions on this topic can be found here:
150- * [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
151- * [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
149+ - [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
150+ - Discussions on this topic can be found here:
151+ - [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
152+ - [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
152153
153154### Install Recipes
154155
@@ -170,23 +171,27 @@ This requires:
170171```lua
171172{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
172173```
174+
173175</details >
174176<details ><summary >Windows with gcc/make using chocolatey</summary >
175177Alternatively, one can install gcc and make which don't require changing the config,
176178the easiest way is to use choco:
177179
1781801 . install [ chocolatey] ( https://chocolatey.org/install )
179- either follow the instructions on the page or use winget,
180- run in cmd as ** admin** :
181+ either follow the instructions on the page or use winget,
182+ run in cmd as ** admin** :
183+
181184```
182185winget install --accept-source-agreements chocolatey.chocolatey
183186```
184187
1851882 . install all requirements using choco, exit the previous cmd and
186- open a new one so that choco path is set, and run in cmd as ** admin** :
189+ open a new one so that choco path is set, and run in cmd as ** admin** :
190+
187191```
188192choco install -y neovim git ripgrep wget fd unzip gzip mingw make
189193```
194+
190195</details >
191196<details ><summary >WSL (Windows Subsystem for Linux)</summary >
192197
@@ -197,16 +202,28 @@ sudo add-apt-repository ppa:neovim-ppa/unstable -y
197202sudo apt update
198203sudo apt install make gcc ripgrep unzip git xclip neovim
199204```
205+
200206</details >
201207
202208#### Linux Install
209+
210+ <details ><summary >Arch Linux Install Steps</summary >
211+
212+ ```
213+ sudo pacman -S neovim make gcc ripgrep unzip git xclip
214+ # If you need additional packages from AUR, use yay:
215+ # yay -S neovim-git # For the git version of neovim
216+ ```
217+
218+ </details >
203219<details ><summary >Ubuntu Install Steps</summary >
204220
205221```
206222sudo add-apt-repository ppa:neovim-ppa/unstable -y
207223sudo apt update
208224sudo apt install make gcc ripgrep unzip git xclip neovim
209225```
226+
210227</details >
211228<details ><summary >Debian Install Steps</summary >
212229
@@ -224,18 +241,20 @@ sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz
224241# make it available in /usr/local/bin, distro installs to /usr/bin
225242sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
226243```
244+
227245</details >
228246<details ><summary >Fedora Install Steps</summary >
229247
230248```
231249sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
232250```
251+
233252</details >
234253
235254<details ><summary >Arch Install Steps</summary >
236255
237256```
238257sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
239258```
240- </details >
241259
260+ </details >
0 commit comments