2024-07-13 17:44:29 +02:00
|
|
|
# kickstart.nvim/
|
2023-02-17 16:31:57 -05:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
<a href="https://dotfyle.com/juanmiguelRuaDev/kickstartnvim"><img src="https://dotfyle.com/juanmiguelRuaDev/kickstartnvim/badges/plugins?style=flat" /></a>
|
|
|
|
|
<a href="https://dotfyle.com/juanmiguelRuaDev/kickstartnvim"><img src="https://dotfyle.com/juanmiguelRuaDev/kickstartnvim/badges/leaderkey?style=flat" /></a>
|
|
|
|
|
<a href="https://dotfyle.com/juanmiguelRuaDev/kickstartnvim"><img src="https://dotfyle.com/juanmiguelRuaDev/kickstartnvim/badges/plugin-manager?style=flat" /></a>
|
2022-06-23 23:35:53 -04:00
|
|
|
|
|
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
## Install Instructions
|
2024-02-26 10:03:53 -05:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
> Install requires Neovim 0.9+. Always review the code before installing a configuration.
|
2022-06-23 23:35:53 -04:00
|
|
|
|
2024-02-26 10:03:53 -05:00
|
|
|
## Installation
|
2022-06-23 23:35:53 -04:00
|
|
|
|
2024-02-26 10:03:53 -05:00
|
|
|
### Install Neovim
|
2023-04-24 15:21:53 -06:00
|
|
|
|
2024-02-26 10:03:53 -05: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-23 23:35:53 -04:00
|
|
|
|
2024-02-26 10:03:53 -05:00
|
|
|
### Install External Dependencies
|
2022-11-09 10:27:08 -05:00
|
|
|
|
2024-02-26 10:03:53 -05:00
|
|
|
External Requirements:
|
|
|
|
|
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
|
2025-05-11 02:23:54 +02:00
|
|
|
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
|
|
|
|
|
[fd-find](https://github.com/sharkdp/fd#installation)
|
2024-12-29 18:39:47 +02:00
|
|
|
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
|
2024-03-06 17:49:44 +01: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
|
2025-02-16 22:37:44 -05:00
|
|
|
- Emoji fonts (Ubuntu only, and only if you want emoji!) `sudo apt install fonts-noto-color-emoji`
|
2024-02-26 10:03:53 -05:00
|
|
|
- Language Setup:
|
2024-08-22 21:49:25 +01:00
|
|
|
- If you want to write Typescript, you need `npm`
|
|
|
|
|
- If you want to write Golang, you will need `go`
|
2024-02-26 10:03:53 -05:00
|
|
|
- etc.
|
|
|
|
|
|
2025-03-20 23:16:35 +01:00
|
|
|
> [!NOTE]
|
2024-03-17 21:22:58 +01:00
|
|
|
> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
|
|
|
|
|
> and quick install snippets
|
2023-09-05 14:12:56 +02:00
|
|
|
|
2024-04-01 16:36:32 +02:00
|
|
|
### Install Kickstart
|
|
|
|
|
|
2025-03-20 23:16:35 +01:00
|
|
|
> [!NOTE]
|
2024-04-01 16:36:32 +02:00
|
|
|
> [Backup](#FAQ) your previous configuration (if any exists)
|
|
|
|
|
|
2023-09-05 14:12:56 +02:00
|
|
|
Neovim's configurations are located under the following paths, depending on your OS:
|
|
|
|
|
|
|
|
|
|
| OS | PATH |
|
|
|
|
|
| :- | :--- |
|
2024-02-26 10:03:53 -05:00
|
|
|
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
|
2024-07-21 23:33:26 +03:00
|
|
|
| Windows (cmd)| `%localappdata%\nvim\` |
|
|
|
|
|
| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` |
|
2023-09-05 14:12:56 +02:00
|
|
|
|
2024-03-20 14:27:18 -04:00
|
|
|
#### Recommended Step
|
|
|
|
|
|
2024-03-21 20:47:55 +01: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.
|
|
|
|
|
|
2025-03-20 23:16:35 +01:00
|
|
|
> [!NOTE]
|
2024-12-29 18:39:47 +02:00
|
|
|
> Your fork's URL will be something like this:
|
2024-03-21 20:47:55 +01:00
|
|
|
> `https://github.com/<your_github_username>/kickstart.nvim.git`
|
2024-03-20 14:27:18 -04:00
|
|
|
|
2024-08-22 21:53:57 +01:00
|
|
|
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
|
|
|
|
|
too - it's ignored in the kickstart repo to make maintenance easier, but it's
|
2024-12-29 18:39:47 +02:00
|
|
|
[recommended to track it in version control](https://lazy.folke.io/usage/lockfile).
|
2024-08-22 21:53:57 +01:00
|
|
|
|
2024-03-20 14:27:18 -04:00
|
|
|
#### Clone kickstart.nvim
|
2025-03-20 23:16:35 +01:00
|
|
|
|
|
|
|
|
> [!NOTE]
|
2024-03-21 20:47:55 +01: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 14:12:56 +02:00
|
|
|
|
2024-02-26 10:03:53 -05:00
|
|
|
<details><summary> Linux and Mac </summary>
|
|
|
|
|
|
2023-11-29 19:34:43 -05:00
|
|
|
```sh
|
2024-07-13 17:44:29 +02:00
|
|
|
git clone git@github.com:juanmiguelRuaDev/kickstart.nvim ~/.config/juanmiguelRuaDev/kickstart.nvim
|
2023-09-05 14:12:56 +02:00
|
|
|
```
|
|
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
Open Neovim with this config:
|
2023-10-25 21:46:24 +02:00
|
|
|
|
|
|
|
|
```sh
|
2024-07-13 17:44:29 +02:00
|
|
|
NVIM_APPNAME=juanmiguelRuaDev/kickstart.nvim/ nvim
|
2023-10-25 21:46:24 +02:00
|
|
|
```
|
|
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
## Plugins
|
2023-10-25 21:46:24 +02:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
### colorscheme
|
2023-09-05 14:12:56 +02:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [catppuccin/nvim](https://dotfyle.com/plugins/catppuccin/nvim)
|
|
|
|
|
+ [folke/tokyonight.nvim](https://dotfyle.com/plugins/folke/tokyonight.nvim)
|
|
|
|
|
### comment
|
2022-12-20 19:27:01 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [numToStr/Comment.nvim](https://dotfyle.com/plugins/numToStr/Comment.nvim)
|
|
|
|
|
+ [folke/todo-comments.nvim](https://dotfyle.com/plugins/folke/todo-comments.nvim)
|
|
|
|
|
### completion
|
2024-03-20 14:27:18 -04:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [hrsh7th/nvim-cmp](https://dotfyle.com/plugins/hrsh7th/nvim-cmp)
|
|
|
|
|
### debugging
|
2024-03-20 14:27:18 -04:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [rcarriga/nvim-dap-ui](https://dotfyle.com/plugins/rcarriga/nvim-dap-ui)
|
|
|
|
|
+ [mfussenegger/nvim-dap](https://dotfyle.com/plugins/mfussenegger/nvim-dap)
|
|
|
|
|
### editing-support
|
2022-12-20 19:27:01 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [windwp/nvim-autopairs](https://dotfyle.com/plugins/windwp/nvim-autopairs)
|
|
|
|
|
+ [nvim-treesitter/nvim-treesitter-context](https://dotfyle.com/plugins/nvim-treesitter/nvim-treesitter-context)
|
|
|
|
|
### file-explorer
|
2023-02-17 16:31:57 -05:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [stevearc/oil.nvim](https://dotfyle.com/plugins/stevearc/oil.nvim)
|
|
|
|
|
+ [nvim-neo-tree/neo-tree.nvim](https://dotfyle.com/plugins/nvim-neo-tree/neo-tree.nvim)
|
|
|
|
|
### formatting
|
2023-02-17 16:31:57 -05:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [stevearc/conform.nvim](https://dotfyle.com/plugins/stevearc/conform.nvim)
|
|
|
|
|
### fuzzy-finder
|
2024-03-17 21:22:58 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [nvim-telescope/telescope.nvim](https://dotfyle.com/plugins/nvim-telescope/telescope.nvim)
|
|
|
|
|
### git
|
2024-03-17 21:22:58 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [lewis6991/gitsigns.nvim](https://dotfyle.com/plugins/lewis6991/gitsigns.nvim)
|
|
|
|
|
+ [kdheepak/lazygit.nvim](https://dotfyle.com/plugins/kdheepak/lazygit.nvim)
|
|
|
|
|
### icon
|
2024-03-17 21:22:58 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [nvim-tree/nvim-web-devicons](https://dotfyle.com/plugins/nvim-tree/nvim-web-devicons)
|
|
|
|
|
### indent
|
2023-02-17 16:31:57 -05:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [lukas-reineke/indent-blankline.nvim](https://dotfyle.com/plugins/lukas-reineke/indent-blankline.nvim)
|
|
|
|
|
### keybinding
|
2023-02-17 16:31:57 -05:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [folke/which-key.nvim](https://dotfyle.com/plugins/folke/which-key.nvim)
|
|
|
|
|
### lsp
|
2023-02-17 16:31:57 -05:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [neovim/nvim-lspconfig](https://dotfyle.com/plugins/neovim/nvim-lspconfig)
|
|
|
|
|
+ [j-hui/fidget.nvim](https://dotfyle.com/plugins/j-hui/fidget.nvim)
|
|
|
|
|
+ [mfussenegger/nvim-lint](https://dotfyle.com/plugins/mfussenegger/nvim-lint)
|
|
|
|
|
+ [nvimtools/none-ls.nvim](https://dotfyle.com/plugins/nvimtools/none-ls.nvim)
|
|
|
|
|
### lsp-installer
|
2023-02-17 16:31:57 -05:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [williamboman/mason.nvim](https://dotfyle.com/plugins/williamboman/mason.nvim)
|
|
|
|
|
### nvim-dev
|
2024-03-03 03:12:55 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [MunifTanjim/nui.nvim](https://dotfyle.com/plugins/MunifTanjim/nui.nvim)
|
|
|
|
|
+ [nvim-lua/plenary.nvim](https://dotfyle.com/plugins/nvim-lua/plenary.nvim)
|
|
|
|
|
+ [folke/neodev.nvim](https://dotfyle.com/plugins/folke/neodev.nvim)
|
|
|
|
|
### plugin-manager
|
2024-03-17 21:22:58 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [folke/lazy.nvim](https://dotfyle.com/plugins/folke/lazy.nvim)
|
|
|
|
|
### snippet
|
2024-03-17 21:22:58 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [rafamadriz/friendly-snippets](https://dotfyle.com/plugins/rafamadriz/friendly-snippets)
|
|
|
|
|
+ [L3MON4D3/LuaSnip](https://dotfyle.com/plugins/L3MON4D3/LuaSnip)
|
|
|
|
|
### syntax
|
2024-03-17 21:22:58 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [echasnovski/mini.surround](https://dotfyle.com/plugins/echasnovski/mini.surround)
|
|
|
|
|
+ [nvim-treesitter/nvim-treesitter-textobjects](https://dotfyle.com/plugins/nvim-treesitter/nvim-treesitter-textobjects)
|
|
|
|
|
+ [nvim-treesitter/nvim-treesitter](https://dotfyle.com/plugins/nvim-treesitter/nvim-treesitter)
|
|
|
|
|
### tabline
|
2024-03-17 21:22:58 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [akinsho/bufferline.nvim](https://dotfyle.com/plugins/akinsho/bufferline.nvim)
|
|
|
|
|
### utility
|
2024-03-17 21:22:58 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ [echasnovski/mini.nvim](https://dotfyle.com/plugins/echasnovski/mini.nvim)
|
|
|
|
|
## Language Servers
|
2024-04-16 10:29:27 -05:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
+ html
|
|
|
|
|
+ tflint
|
2024-04-16 10:29:27 -05:00
|
|
|
|
2025-05-11 20:45:35 +02:00
|
|
|
> [!NOTE]
|
|
|
|
|
> For more information about a particular plugin check its repository's documentation.
|
2024-04-16 10:29:27 -05:00
|
|
|
|
2024-03-03 03:12:55 +01:00
|
|
|
|
2024-07-13 17:44:29 +02:00
|
|
|
This readme was generated by [Dotfyle](https://dotfyle.com)
|