mirror
/
kickstart.nvim
mirror of https://github.com/nvim-lua/kickstart.nvim.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
kickstart.nvim/README.md

247 lines
11 KiB
Markdown
Raw Blame History

# Florian Teichs fork of kickstart.nvim
## Installation
### Install Neovim
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.
### Install External Dependencies
External Requirements:
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
[fd-find](https://github.com/sharkdp/fd#installation)
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
- 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
- Emoji fonts (Ubuntu only, and only if you want emoji!) `sudo apt install fonts-noto-color-emoji`
- Language Setup:
- If you want to write Typescript, you need `npm`
- If you 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)
Neovim's configurations are located under the following paths, depending on your OS:
| OS | PATH |
| :- | :--- |
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| Windows (cmd)| `%localappdata%\nvim\` |
| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` |
#### Recommended Step
#### Clone kickstart.nvim
<details><summary> Linux and Mac </summary>
```sh
git clone https://github.com/FlorianTeich/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
</details>
<details><summary> Windows </summary>
If you're using `cmd.exe`:
```
git clone https://github.com/FlorianTeich/kickstart.nvim.git "%localappdata%\nvim"
```
If you're using `powershell.exe`
```
git clone https://github.com/FlorianTeich/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"
```
</details>
### Post Installation
Start Neovim
```sh
nvim
```
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
the current plugin status. Hit `q` to close the window.
### FAQ
* What should I do if I already have a pre-existing Neovim configuration?
* 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:
```
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.
* What if I want to "uninstall" this configuration:
* See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information
* 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 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
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)
### Install Recipes
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
```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 the 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 git xclip 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 xclip neovim
```
</details>
<details><summary>Debian Install Steps</summary>
```
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl
# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
sudo rm -rf /opt/nvim-linux-x86_64
sudo mkdir -p /opt/nvim-linux-x86_64
sudo chmod a+rX /opt/nvim-linux-x86_64
sudo tar -C /opt -xzf nvim-linux-x86_64.tar.gz
# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
```
</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>
## Keymaps
| Mode | Keys | Action | Description |
| ------------ | ------------ | --------------------------- | ----------------------------- |
| **Normal** | `<Esc>` | `:nohlsearch` | Clear search highlights |
| **Normal** | `<leader>q` | `vim.diagnostic.setloclist` | Open diagnostic quickfix list |
| **Terminal** | `<Esc><Esc>` | `<C-\><C-n>` | Exit terminal mode |
| **Normal** | `<C-h>` | `<C-w><C-h>` | Move focus to left split |
| **Normal** | `<C-l>` | `<C-w><C-l>` | Move focus to right split |
| **Normal** | `<C-j>` | `<C-w><C-j>` | Move focus to lower split |
| **Normal** | `<C-k>` | `<C-w><C-k>` | Move focus to upper split |
| Mode | Keys | Telescope Action | Description |
| ---------- | ------------------ | ---------------------------- | ------------------------------ |
| **Normal** | `<leader>sh` | `help_tags` | Search help |
| **Normal** | `<leader>sk` | `keymaps` | Search keymaps |
| **Normal** | `<leader>sf` | `find_files` | Search files |
| **Normal** | `<leader>ss` | `builtin` | Search Telescope pickers |
| **Normal** | `<leader>sw` | `grep_string` | Search word under cursor |
| **Normal** | `<leader>sg` | `live_grep` | Grep search |
| **Normal** | `<leader>sd` | `diagnostics` | Search diagnostics |
| **Normal** | `<leader>sr` | `resume` | Resume last Telescope search |
| **Normal** | `<leader>s.` | `oldfiles` | Search recent files |
| **Normal** | `<leader><leader>` | `buffers` | Find buffers |
| **Normal** | `<leader>/` | `current_buffer_fuzzy_find` | Fuzzy find in current buffer |
| **Normal** | `<leader>s/` | Live grep open files | Grep through open files only |
| **Normal** | `<leader>sn` | `find_files` (Neovim config) | Search Neovim config directory |
| Mode | Keys | Action | Description |
| ------------------- | ------------ | ------------------------------- | --------------------------------------- |
| **Normal** | `grn` | `vim.lsp.buf.rename` | Rename symbol |
| **Normal / Visual** | `gra` | `vim.lsp.buf.code_action` | Code actions |
| **Normal** | `grr` | `lsp_references` | Find references |
| **Normal** | `gri` | `lsp_implementations` | Go to implementation |
| **Normal** | `grd` | `lsp_definitions` | Go to definition |
| **Normal** | `grD` | `vim.lsp.buf.declaration` | Go to declaration |
| **Normal** | `gO` | `lsp_document_symbols` | Document symbols |
| **Normal** | `gW` | `lsp_dynamic_workspace_symbols` | Workspace symbols |
| **Normal** | `grt` | `lsp_type_definitions` | Go to type definition |
| **Normal** | `<leader>th` | Toggle inlay hints | Toggle LSP inlay hints (when supported) |
| Mode | Keys | Action | Description |
| --------------------------- | ----------- | ---------------- | --------------------- |
| **All modes (`mode = ''`)** | `<leader>f` | `conform.format` | Format current buffer |
Reference in New Issue View Git Blame Copy Permalink