https://github.com/flamendless/nvim-config
Using https://github.com/nvim-lua/kickstart.nvim
https://github.com/flamendless/nvim-config
Last synced: about 2 months ago
JSON representation
Using https://github.com/nvim-lua/kickstart.nvim
- Host: GitHub
- URL: https://github.com/flamendless/nvim-config
- Owner: flamendless
- License: mit
- Created: 2023-01-18T11:14:05.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2026-02-28T03:17:51.000Z (4 months ago)
- Last Synced: 2026-02-28T08:26:18.194Z (4 months ago)
- Language: Lua
- Size: 179 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
### Introduction
A starting point for Neovim that is:
* Small (<500 lines)
* Single-file
* Documented
* Modular
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.
This repo is meant to be used as a starting point for a user's own configuration; remove the things you don't use and add what you miss. Please refrain from leaving comments about enabling / disabling particular languages out of the box.
### Installation
* Backup your previous configuration
* Copy and paste the kickstart.nvim `init.lua` into `$HOME/.config/nvim/init.lua` (Linux) or `~/AppData/Local/nvim/init.lua` (Windows)
* Start Neovim (`nvim`) and run `:Lazy` to install plugins
* Restart Neovim
**nvim-treesitter:** To install language parsers (`:TSInstall`), the tree-sitter CLI is required. Install it once:
- **macOS (Homebrew):** `brew install tree-sitter-cli`
- **npm:** `npm install -g tree-sitter-cli`
- **Cargo:** `cargo install --locked tree-sitter-cli`
Then run `:TSInstall` for the languages you want, or let the config install them on first use.
If there are languages that you don't want to use, remove their configuration and notes from your `init.lua` after copy and pasting (for example, in the mason configuration).
### Windows Installation
Installation may require installing build tools, and updating the run command for `telescope-fzf-native`
See `telescope-fzf-native` documention 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
For Lazy.nvim, use `build` instead of `run` in the plugin spec:
```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' }
```
### Configuration
You could directly modify the `init.lua` file with your personal customizations. This option is the most straightforward, but if you update your config from this repo, you may need to reapply your changes.
An alternative approach is to add your own plugins under `lua/plugins/` (each file returns a Lazy spec or table of specs). You can also use the `/after/plugin/` directory for other customizations (see `:help load-plugins`).
#### Example `plugins.lua`
The following is an example of a `plugins.lua` module (located at `$HOME/.config/nvim/lua/custom/plugins.lua`) where you can register your own plugins.
```lua
-- For Lazy.nvim: add a file under lua/plugins/ (e.g. lua/plugins/which-key.lua)
return {
"folke/which-key.nvim",
config = function()
require("which-key").setup({})
end,
}
```
Alternatively, add plugin specs under `lua/plugins/` (e.g. `lua/plugins/which-key.lua`) to register your own plugins with Lazy.
#### Example `defaults.lua`
For further customizations, you can add a file in the `/after/plugin/` folder (see `:help load-plugins`) to include your own options, keymaps, autogroups, and more. The following is an example `defaults.lua` file (located at `$HOME/.config/nvim/after/plugin/defaults.lua`).
```lua
vim.opt.relativenumber = true
vim.keymap.set('n', 'sr', require('telescope.builtin').resume, { desc = '[S]earch [R]esume' })
```
### Contribution
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
* Lazy-loading. Kickstart.nvim should start within 40 ms on modern hardware. Please profile and contribute to upstream plugins to optimize startup time instead.
Each PR, especially those which increase the line count, should have a description as to why the PR is necessary.
### 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/`