Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/comfysage/chaivim
:tea: easily configurable neovim system with solid defaults and a cozy editor experience.
https://github.com/comfysage/chaivim
chaivim neovim neovim-configuration neovim-plugin neovim-plugins neovim-setup nvim nvim-lua nvim-plugin nvim-plugins
Last synced: 28 days ago
JSON representation
:tea: easily configurable neovim system with solid defaults and a cozy editor experience.
- Host: GitHub
- URL: https://github.com/comfysage/chaivim
- Owner: comfysage
- License: apache-2.0
- Created: 2023-12-01T14:24:25.000Z (about 1 year ago)
- Default Branch: mega
- Last Pushed: 2024-05-21T12:36:25.000Z (8 months ago)
- Last Synced: 2024-05-22T12:20:20.029Z (8 months ago)
- Topics: chaivim, neovim, neovim-configuration, neovim-plugin, neovim-plugins, neovim-setup, nvim, nvim-lua, nvim-plugin, nvim-plugins
- Language: Lua
- Homepage:
- Size: 1.76 MB
- Stars: 36
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - crispybaccoon/chaivim - Easily configurable distro with solid defaults and a cozy editor experience. (Preconfigured Configuration / Competitive Programming)
README
# chaivim
:tea: easily configurable neovim system with solid defaults and a cozy editor experience.
## :sparkles: Features
### Lazy plugin management
chaivim uses [lazy.nvim](https://github.com/folke/lazy.nvim) to manage plugins.
### integrated plugins
- :telescope: [telescope](https://github.com/nvim-telescope/telescope.nvim) - a highly extendable fuzzy finder.
- :evergreen_tree: [treesitter](https://github.com/nvim-treesitter/nvim-treesitter) - treesitter configurations and abstraction layer for neovim.
- :pencil: [none-ls](https://github.com/nvimtools/none-ls.nvim) - abstraction layer for lsp diagnostics, code actions, and formatters.
- :computer: [keymaps](https://github.com/comfysage/keymaps.nvim) - a keymap manager for neovim.
- :airplane: [lualine](https://github.com/nvim-lualine/lualine.nvim) - a blazing fast and easy to configure neovim statusline plugin.
- :pencil: [cmp](https://github.com/hrsh7th/nvim-cmp) - a completion plugin for neovim.
- :scissors: [luasnip](https://github.com/L3MON4D3/LuaSnip) with [friendly-snippets](https://github.com/rafamadriz/friendly-snippets) - a snippet engine for neovim.
- :hammer: [mini.nvim](https://github.com/echasnovski/mini.nvim) - the "swiss army knife" among neovim plugins.
- :vertical_traffic_light: [gitsigns](https://github.com/lewis6991/gitsigns.nvim) - git integration for neovim.
- :scroll: [which-key](https://github.com/folke/which-key.nvim) - a keymap ui for neovim.
- :pushpin: [todo-comments](https://github.com/folke/todo-comments.nvim) - highlight, list and search todo comments in your projects.
- :construction: [trouble](https://github.com/folke/trouble.nvim) - a diagnostics manager.
- :balloon: [incline](https://github.com/b0o/incline.nvim) - floating statuslines for neovim.
- :straight_ruler: [indent-blankline](https://github.com/lukas-reineke/indent-blankline.nvim) - indent guides for neovim.
## :lock: requirements
- Neovim `>= 0.10.0` (needs to be built with LuaJIT)
- git `>= 2.19.0` (for partial clones support)
- a Nerd Font (optional)
- [luarocks](https://luarocks.org/) to install rockspecs.
## :package: installation
chaivim can be installed [manually](#manual-install) or through the installer:
```shell
curl -fsSL https://github.com/comfysage/chaivim/raw/mega/utils/installer/install.sh | sh
```
### manual install
```lua
-- init.lua
local rootpath = vim.fn.stdpath("data") .. "/ch"
local chaipath = rootpath .. "/chai"
if not vim.uv.fs_stat(chaipath) then
vim.system({
"git",
"clone",
"--filter=blob:none",
"https://github.com/comfysage/chaivim.git",
chaipath,
}):wait()
end
vim.opt.rtp:prepend(chaipath)
```
## :rocket: usage
```lua
-- init.lua
require 'ch'.setup('custom.config', 'custom.modules')
-- lua/custom/config.lua
return {
ui = {
colorscheme = 'evergarden',
transparent_background = false,
},
}
-- lua/custom/modules.lua
return {
ch = {
{
'options',
opts = {
cursorline = false,
tab_width = 2,
scrolloff = 5,
},
},
{
'dash',
opts = {
open_on_startup = true,
},
},
},
custom = {
-- your custom modules (in `lua/custom/`)
},
}
```
or call `require 'ch'.setup 'custom'` to load a custom configuration from `lua/custom/init.lua`:
```lua
-- init.lua
require 'ch'.setup 'custom'
-- lua/custom/init.lua
return {
ui = {
colorscheme = 'evergarden',
},
modules = {
ch = {
{ 'options' },
{ 'base' },
},
},
}
```
all config fields can be overwritten after `setup()`:
```lua
ch.config.ui.colorscheme = 'tokyonight'
```
## :gear: config modules
view example configurations for modules [here](doc/modules.md).
## :camera: screenshots
