Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaeheonji/nvim
Simple and extensible neovim config with awesome community plugins 🚀
https://github.com/jaeheonji/nvim
ide lua neovim neovim-config neovim-configuration vim
Last synced: about 1 month ago
JSON representation
Simple and extensible neovim config with awesome community plugins 🚀
- Host: GitHub
- URL: https://github.com/jaeheonji/nvim
- Owner: jaeheonji
- License: mit
- Created: 2022-03-18T14:45:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-19T07:59:41.000Z (about 2 years ago)
- Last Synced: 2023-03-08T01:20:25.945Z (over 1 year ago)
- Topics: ide, lua, neovim, neovim-config, neovim-configuration, vim
- Language: Lua
- Homepage:
- Size: 101 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
nvim
Just nvim. It is an simple and extensible neovim config with awesome community plugins.
## :art: Screenshots
| | | |
|---------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
|  |  |  |
|  |  |  |
## :wrench: Requirments
* [Nerd Fonts](https://github.com/ryanoasis/nerd-fonts)
* [Neovim 0.7+](https://github.com/neovim/neovim)
* Plugin Requirements:
* [ripgrep](https://github.com/BurntSushi/ripgrep) (live grep for `telescope`)
* `curl` or `wget` (for `mason`)
> Note the screenshots used **JetBrainsMono Nerd Font**.
## :rocket: Installation
```bash
git clone https://github.com/jaeheonji/nvim $HOME/.config/nvim && nvim
```
## :sparkles: Features
* Soothing pastel theme by [catppuccin](https://github.com/catppuccin/nvim)
* Dashboard with [alpha-nvim](https://github.com/goolord/alpha-nvim)
* Buffer & Tab line with [bufferline.nvim](https://github.com/akinsho/bufferline.nvim)
* Neovim LSP with [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) and [mason.nvim](https://github.com/williamboman/mason.nvim)
* Autocompletion with [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
* Diagnositcs, code actions and more with [null-ls.nvim](https://github.com/jose-elias-alvarez/null-ls.nvim)
* Statusline with [feline.nvim](https://github.com/feline-nvim/feline.nvim)
* File browse with [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim)
* Fuzzy find with [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
* Popup suggestions and key binding with [which-key.nvim](https://github.com/folke/which-key.nvim)
* Git integration for buffers with [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim)
* Syntax highlighting with [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
* Autopair with [nvim-autopairs](https://github.com/windwp/nvim-autopairs)
* Powerful commenting with [comment.nvim](https://github.com/numToStr/Comment.nvim)
A list of all plugins can be found [here](./docs/PLUGINS.md).
## :memo: Configuration
One of the goals of this project is to provide users with a extensible user configuration. And the user configuration should be easy to understand and simple.
First, To set up a user configuration, copy the default config to `custom.lua`.
```
cp ~/.config/nvim/lua/core/config.lua ~/.config/nvim/lua/custom.lua
```
> Please check the file name and path. Currently, only one path is supported.
The user configuration provides five components:
* `colorscheme`
* `options`
* `key_bindings`
* `plugins`
* `hooks`
### colorscheme
The `colorscheme` currently only provides [`catppuccin/nvim`](https://github.com/catppuccin/nvim). Instead, you can set up transparency through the `transparency` option. This options is `false` by default.
### options
You can set `options` for neovim. If you want to turn off the default options and set a new value, you can do the following.
```lua
options = {
enable_default = false, -- disable default options
setup = function()
vim.opt.number = true
vim.opt.relativenumber = false
...
end,
}
```
### key_bindings
Same as `options`. Note that this project basically supports `which-key`, so you can use `which-key` to key-binding as follows.
```lua
options = {
enable_default = true,
setup = function()
local default_opts = { noremap = true, silent = true }
local map = vim.keymap.set
-- bind with vim.keymap.set function
map({ "n", "v" }, "", '"+y', default_opts)
map({ "n" }, "", '"+p', default_opts)
-- using which-key
local ok, wkey = pcall(require, "which-key")
if not ok then
return
end
wkey.register({ ... })
end,
}
```
### plugins
The `plugins` are one of the most important components of user configuration. The plugins provides two options. The first is to add a new plugin and the rest is to override the settings for the plugin provided by this project.
**Add new plugins**
```lua
plugins = {
custom = {
{
-- I love Rust :)
"simrat39/rust-tools.nvim"
ft = { "rust "},
config = function()
require("rust-tools").setup({ ... })
end
}
}
...
}
```
**Override settings**
Override settings uses the same table as each plugin settings by default. But, for `null-ls` and `lspconfig` settings, use custom settings for convenience. The following is an example.
```lua
plugins = {
override = {
["lspconfig"] = {
servers = {
sumneko_lua = { on_attch = function() ... end },
gopls = {},
golangci_lint_ls = {},
}
},
["null-ls"] = {
source = {
"code_actions.gitsigns",
"formatting.stylua",
}
}
}
}
```
For more user configuration examples, check out my [configuration](./docs/CONFIGURATION.md).