https://github.com/reybits/config-nvim
My Neovim config.
https://github.com/reybits/config-nvim
config linux macos nvim
Last synced: about 1 year ago
JSON representation
My Neovim config.
- Host: GitHub
- URL: https://github.com/reybits/config-nvim
- Owner: reybits
- License: mit
- Created: 2025-02-21T12:02:10.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-14T16:00:24.000Z (over 1 year ago)
- Last Synced: 2025-03-14T16:46:07.438Z (over 1 year ago)
- Topics: config, linux, macos, nvim
- Language: Lua
- Homepage:
- Size: 1.41 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nvim from Scratch
[](https://dotfyle.com/reybits/config-nvim-nvim)
[](https://dotfyle.com/reybits/config-nvim-nvim)
[](https://dotfyle.com/reybits/config-nvim-nvim)
This repository contains my custom Neovim configuration for Linux, macOS, and potentially Windows. The setup is built from scratch and includes only the plugins I actively use in my workflow. I primarily use Neovim as a C++ IDE for cross-platform game development.
For the best experience, use it alongside my [config-tmux](https://github.com/reybits/config-tmux.git) repository.
## 📦 Install
```sh
git clone https://github.com/reybits/config-nvim.git ~/.config/nvim
```
## ⚡️ Requirements
- [fzf](https://github.com/junegunn/fzf): a command-line fuzzy finder.
- [viu](https://github.com/atanunq/viu): a terminal image viewer with native support for iTerm and Kitty.
- [fd](https://github.com/sharkdp/fd): a better version of the find utility.
- [ripgrep(rg)](https://github.com/BurntSushi/ripgrep): a better version of the grep utility.
## ✨ Features
### Enabled by default
- Plugin management via [lazy.nvim](https://github.com/folke/lazy.nvim.git).
- Tool manager via [mason.nvim](https://github.com/williamboman/mason.nvim).
- Startup screen via [dashboard-nvim](https://github.com/nvimdev/dashboard-nvim).
- Sessions support via [mini.sessions](https://github.com/echasnovski/mini.sessions).
- Colorscheme via [kanagawa.nvim](https://github.com/rebelot/kanagawa.nvim).
- Mapping hint via [which-key.nvim](https://github.com/folke/which-key.nvim).
- Git integration via [neogit](https://github.com/NeogitOrg/neogit), [vim-fugitive](https://github.com/tpope/vim-fugitive), [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim), and [gitlinker.nvim](https://github.com/ruifm/gitlinker.nvim).
- File explorer via [oil.nvim](https://github.com/stevearc/oil.nvim).
- Language server protocol (LSP) support via [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig).
- Code auto-completion via [blink-cmp](https://github.com/Saghen/blink.cmp).
- Code debugging via [mfussenegger/nvim-dap](https://github.com/mfussenegger/nvim-dap) and [rcarriga/nvim-dap-ui](https://github.com/rcarriga/nvim-dap-ui).
- Code commenting via [ts-comments.nvim](https://github.com/folke/ts-comments.nvim).
- Code formatting via [conform.nvim](https://github.com/stevearc/conform.nvim).
- Code highlighting via [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter).
- TMUX support via [vim-tmux-navigator](https://github.com/christoomey/vim-tmux-navigator).
- Improved quickfix UI via [quicker.nvim](https://github.com/stevearc/quicker.nvim).
- Fast navigation, lookup, and more via [fzf-lua](https://github.com/ibhagwan/fzf-lua).
- Buffer navigation via [flash.nvim](https://github.com/folke/flash.nvim).
- Bookmarks via [harpoon](https://github.com/ThePrimeagen/harpoon) v2.
- Undo tree explorer via [undotree](https://github.com/mbbill/undotree).
- Markdown writing and previewing via [render-markdown.nvim](https://github.com/MeanderingProgrammer/render-markdown.nvim) and [markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim).
- Hide passwords/keys via [cloak.nvim](https://github.com/laytan/cloak.nvim).
- Blind typing trainer via [typr](https://github.com/nvzone/typr).
- And more...
### Optional
- Telescope [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim).
- File tree explorer via [nvim-tree.lua](https://github.com/nvim-tree/nvim-tree.lua).
- File tree explorer via [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).
- LazyGit [lazygit.nvim](https://github.com/kdheepak/lazygit.nvim).
- Octo [octo.nvim](https://github.com/pwntester/octo.nvim).
- Codeium [neocodeium](https://github.com/monkoose/neocodeium).
- Colorscheme Nightfox [nightfox.nvim](https://github.com/EdenEast/nightfox.nvim).
- Folding nvim-ufo [kevinhwang91/nvim-ufo](https://github.com/kevinhwang91/nvim-ufo).
## ⚙️ Customization
To customize plugins, enable, or disable integration with other tools, inside the `nvim/lua/scratch/custom` directory, create a `plugin-name.lua` file with the plugin name and add custom settings.
### Navigation related
By default, fzf-lua and oil.nvim used as the navigation plugins.
#### Telescope
You can use Telescope as main plugin by creating a `telescope.lua` file with the following content:
```lua
-- nvim/lua/scratch/custom/telescope.lua
return {
-- Use telescope instead of fzf-lua
require("scratch.custom.optional.telescope"),
{ "ibhagwan/fzf-lua", enabled = false },
}
```
#### Neo-tree
You can use neo-tree as main plugin by creating a `neo-tree.lua` file with the following content:
```lua
-- nvim/lua/scratch/custom/neo-tree.lua
return {
-- Use nvim-tree instead of neo-tree
require("scratch.custom.optional.neo-tree"),
{ "stevearc/oil.nvim", enabled = false },
}
```
#### Nvim-tree
You can use nvim-tree as main plugin by creating a `nvim-tree.lua` file with the following content:
```lua
-- nvim/lua/scratch/custom/nvim-tree.lua
return {
-- Use nvim-tree instead of neo-tree
require("scratch.custom.optional.nvim-tree"),
{ "stevearc/oil.nvim", enabled = false },
}
```
### Git related
By default, Neogit and vim-fugitive is used as the Git plugin.
#### LazyGit as main git plugin
You can use LazyGit as main git plugin by creating a `lazygit.lua` file with the following content:
```lua
-- nvim/lua/scratch/custom/lazygit.lua
return {
-- Use LazyGit instead of Neogit and vim-fugitive
require("scratch.custom.optional.lazygit"),
{ "NeogitOrg/neogit", enabled = false },
{ "tpope/vim-fugitive", enabled = false },
}
```
#### Fugitive as main git plugin
You can use Fugitive as main git plugin by creating a `fugitive.lua` file with the following content:
```lua
-- nvim/lua/scratch/custom/fugitive.lua
return {
-- Use vim-fugitive and its companions instead of Neogit
require("scratch.custom.optional.vim-rhubarb"),
require("scratch.custom.optional.vim-flog"),
{ "NeogitOrg/neogit", enabled = false },
}
```
#### Octo as GitHub companion
You can add support for the Octo plugin to work with GitHub by creating a `octo.lua` file with the following content:
```lua
-- nvim/lua/scratch/custom/octo.lua
return {
require("scratch.custom.optional.octo"),
}
```
### AI related
#### Copilot
Both Copilot and CopilotChat plugins are enabled by defautl. Copilot integrated into the completion menu via blink-cmp.
You can disable Copilot by creating a `copilot.lua` file with the following content:
```lua
-- nvim/lua/scratch/custom/copilot.lua
return {
-- Disable Copilot and Copilot Chat
{ "github/copilot.vim", enabled = false },
{ "CopilotC-Nvim/CopilotChat.nvim", enabled = false },
}
```
#### Codeium
Codeium is disabled by default. However, you can enable it by creating a `codeium.lua` file with the following content:
```lua
-- nvim/lua/scratch/custom/codeium.lua
return {
-- Enable Codeium without the completion menu support,
-- use mappings instead:
-- to accept suggestion
-- to cycle through suggestions
require("scratch.custom.optional.neocodeium"),
}
```
### Editor related
#### Folding via UFO
Here’s a detailed guide on enabling and extending folding with nvim-ufo in Neovim.
```lua
-- nvim/lua/scratch/custom/editor.lua
return {
-- Enable nvim-ufo
require("scratch.custom.optional.nvim-ufo"),
}
```
## 🚀 Useful links
- [fzf-lua wiki](https://github.com/ibhagwan/fzf-lua/wiki).
- [lazydev.nvim](https://github.com/folke/lazydev.nvim).