2021-06-26 07:12:02 +00:00
< h1 align = "center" > NvChad< / h1 >
2021-05-17 20:14:10 +00:00
2021-06-26 07:03:02 +00:00
< div align = "center" >
2021-08-19 04:55:22 +00:00
< a href = "https://nvchad.netlify.app/" > Home< / a >
2021-06-26 07:03:02 +00:00
< span > • < / span >
2021-08-21 23:26:48 +00:00
< a href = "https://nvchad.netlify.app/getting-started/setup" > Install< / a >
2021-06-26 07:03:02 +00:00
< span > • < / span >
2021-08-23 00:44:33 +00:00
< a href = "https://nvchad.netlify.app/contribute" > Contribute< / a >
2021-06-26 07:03:02 +00:00
< span > • < / span >
2021-06-26 07:19:12 +00:00
< a href = "https://github.com/siduck76/NvChad#gift_heart-support" > Support< / a >
2021-06-26 07:03:02 +00:00
< span > • < / span >
< a href = "https://github.com/siduck76/NvChad/wiki/Chad-user-configs" > Extras< / a >
< p > < / p >
< / div >
2021-07-01 15:06:57 +00:00
< div align = "center" >
2021-07-02 07:53:01 +00:00
2021-09-04 16:25:57 +00:00
[](https://lua.org)
2021-07-02 07:53:01 +00:00
2021-07-02 07:51:18 +00:00
< / div >
2021-07-02 02:06:20 +00:00
2021-07-02 07:51:18 +00:00
< div align = "center" >
2021-07-02 06:27:02 +00:00
[]()
2021-06-29 03:22:28 +00:00
< a href = "https://github.com/siduck76/NvChad"
>< img
2021-07-02 06:27:02 +00:00
src="https://img.shields.io/github/repo-size/siduck76/NvChad?style=flat-square& label=Repo"
2021-06-29 03:22:28 +00:00
alt="GitHub repository size"
/>< / a >
< a href = "https://github.com/siduck76/NvChad/blob/main/LICENSE"
>< img
2021-07-02 06:27:02 +00:00
src="https://img.shields.io/github/license/siduck76/NvChad?style=flat-square& logo=GNU& label=License"
2021-06-29 03:22:28 +00:00
alt="License"
/>
2021-08-08 04:03:57 +00:00
[](https://discord.gg/gADmkJb9Fb)
2021-07-02 06:27:02 +00:00
[](https://github.com/neovim/neovim)
[](https://github.com/siduck76/NvChad/issues)
2021-07-05 10:00:53 +00:00
[](https://github.com/siduck76/NvChad/pulse)
2021-07-02 02:06:20 +00:00
2021-07-05 10:00:53 +00:00
< / div >
2021-07-01 13:45:29 +00:00
2021-09-04 15:42:39 +00:00
## Showcase
2021-09-04 16:25:57 +00:00
< img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/dashboard-nvim.png" > < hr >
< img src = "https://cdn.discordapp.com/attachments/610012460828852229/853933487295299584/unknown.png" > < hr >
< img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim1.png" > < hr >
< img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim.png" > < hr >
2021-03-10 09:05:16 +00:00
2021-09-04 16:58:54 +00:00
< details > < summary > < h2 > Theme Showcase (Click to expand!)< / h2 > < / summary >
2021-08-19 19:10:45 +00:00
2021-09-04 16:58:54 +00:00
< / details >
2021-09-04 15:42:39 +00:00
## Very useful plugins used
2021-03-14 16:48:48 +00:00
2021-09-04 15:42:39 +00:00
### Nvim-tree.lua
2021-03-26 05:02:04 +00:00
2021-09-04 15:42:39 +00:00
Fast file tree:
2021-03-26 05:02:04 +00:00
2021-09-04 15:42:39 +00:00
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png" > < / kbd > < hr >
2021-03-13 08:04:10 +00:00
2021-06-26 07:03:02 +00:00
### Telescope-nvim
2021-03-26 05:02:04 +00:00
A fuzzy file finder, picker, sorter, previewer and much more:
2021-09-04 16:25:57 +00:00
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png" > < / kbd > < hr >
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/tel.png" > < / kbd >
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/telmedia.png" > < / kbd > < hr >
2021-03-26 05:02:04 +00:00
2021-06-26 07:03:02 +00:00
### Indent-blankline.nvim
2021-03-26 05:02:04 +00:00
2021-09-04 16:25:57 +00:00
Adds indentline:
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png" > < / kbd > < hr >
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/blanklineNvim.png" > < / kbd >
2021-03-13 08:04:10 +00:00
2021-09-04 11:37:36 +00:00
### Feline.nvim
2021-03-26 05:02:04 +00:00
2021-09-04 11:37:36 +00:00
Highly configurable statusline plugin:
2021-09-04 16:25:57 +00:00
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png" > < / kbd > < hr >
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/statusline.png" > < / kbd > < hr >
2021-03-26 05:02:04 +00:00
2021-06-26 07:03:02 +00:00
### Nvim-bufferline.lua
2021-03-26 05:02:04 +00:00
2021-09-04 16:25:57 +00:00
Better tab implementation:
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png" > < / kbd > < hr >
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/bufferline.png" > < / kbd >
2021-03-26 05:02:04 +00:00
2021-06-26 07:03:02 +00:00
### Nvim-web-devicons
2021-09-04 16:25:57 +00:00
Lua fork of Vim Devicons which offers more file icon customisability:
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png" > < / kbd > < hr >
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/image.png" > < / kbd >
2021-06-26 07:03:02 +00:00
### Nvim-treesitter
2021-09-04 16:25:57 +00:00
Better syntax highlighting for programming languages (NvChad by default comes with Lua/bash treesitter parsers).
Without/with Treesitter:
2021-03-13 03:05:22 +00:00
2021-09-04 16:25:57 +00:00
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png" > < / kbd > < hr >
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/woTree.png" > < / kbd >
2021-03-26 05:02:04 +00:00
2021-09-04 16:25:57 +00:00
## Credits
2021-06-26 12:21:11 +00:00
2021-09-04 16:25:57 +00:00
- [Elianiva ](https://github.com/elianiva ) helped me with NeoVim Lua related issues many times, NvChad wouldnt exist without his help at all.
- @lorvethe for making the beautiful NvChad logo.
2021-06-26 12:21:11 +00:00
2021-09-04 15:42:39 +00:00
## Features
2021-09-04 16:25:57 +00:00
- Many beautiful themes to choose from.
- Distraction free modes.
- Fast plugin loading.
- Smooth scrolling.
- Autosaving.
- File navigation with [nvim-tree.lua ](https://github.com/kyazdani42/nvim-tree.lua ).
- Managing tabs, buffers with [bufferline.nvim ](https://github.com/akinsho/bufferline.nvim ).
- Beautiful and configurable icons with [nvim-web-devicons ](https://github.com/kyazdani42/nvim-web-devicons ).
- Pretty and functional statusline with [feline.nvim ](https://github.com/Famiu/feline.nvim ).
- Git diffs and more with [gitsigns.nvim ](https://github.com/lewis6991/gitsigns.nvim ) .
- NeoVim Lisp configuration with [nvim-lspconfig ](https://github.com/neovim/nvim-lspconfig ).
- Easy Lisp server installation with [nvim-lspinstall ](https://github.com/kabouzeid/nvim-lspinstall ).
- Autocompletion with [nvim-cmp ](https://github.com/hrsh7th/nvim-cmp ).
- File searching, previewing image and text files and more with [telescope.nvim ](https://github.com/nvim-telescope/telescope.nvim ).
- Syntax highlighting with [nvim-treesitter ](https://github.com/nvim-treesitter/nvim-treesitter ).
- Autoclosing braces and html tags with [nvim-autopairs ](https://github.com/windwp/nvim-autopairs ).
- Formatting code with [neoformat ](https://github.com/sbdchd/neoformat ).
- Indentlines with [indent-blankline.nvim ](https://github.com/lukas-reineke/indent-blankline.nvim ).
- Useful snippets with [LuaSnip ](https://github.com/L3MON4D3/LuaSnip ).
## Bloat
2021-08-19 13:00:23 +00:00
2021-09-04 16:25:57 +00:00
To everyone who thinks that NvChad is bloat: Bloat means different things to everyone.
2021-09-04 17:07:25 +00:00
NvChad has 38 plugins installed by default yet it is still very fast because it uses Packer plugin maanager. Packer.nvim allows you lets you lazy load plugins, meaning they get loaded only when absoloutely required. Furthermore, you can disable plugins you don't use in `chardrc.lua` .
2021-07-14 01:24:14 +00:00
< img src = "https://chadpaste.com/f/kdmxdabxbk.png" >
2021-03-26 05:02:04 +00:00
# TODO
2021-09-04 16:25:57 +00:00
NvChad is focusing more on improving its already existing plugins and features instead of adding more plugins. Things you can do to help currently are:
2021-06-15 18:09:40 +00:00
2021-09-04 16:25:57 +00:00
- Improving base plugins configurations
- Debloating the config.
- Adding more themes.
2021-03-26 05:02:04 +00:00
2021-09-04 16:25:57 +00:00
## Try NvChad in a Docker container
2021-08-22 14:09:45 +00:00
2021-09-04 16:25:57 +00:00
This will leave your current Neovim configuration untouched. Once you exit Neovim, the image is deleted.
2021-08-22 14:09:45 +00:00
```zsh
docker run -w /root -it --rm alpine:edge sh -uelic '
apk add git nodejs neovim ripgrep alpine-sdk --update
git clone https://github.com/NvChad/NvChad ~/.config/nvim
nvim -c "autocmd User PackerComplete quitall" -c "PackerSync"
nvim
'
```
2021-09-04 16:25:57 +00:00
## Chadributors
2021-08-14 10:42:44 +00:00
2021-09-04 16:25:57 +00:00
< a href = "https://github.com/NvChad/NvChad/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=siduck76/NvChad" / >
2021-08-14 10:42:44 +00:00
< / a >
2021-08-20 16:32:41 +00:00
## Warning
2021-06-15 18:09:40 +00:00
2021-09-04 16:25:57 +00:00
If you have an issue with a plugin in NvChad, first you should report it to NvChad to see if it's an issue with it.
2021-09-04 16:58:54 +00:00
## :gift_heart: Support
If you want to donate, I (siduck76) would direct you to one of the donation links below, since NvChad wouldn't have been able without all of its great contributors, I don't feel comfortable taking donations for myself, so donate to one of these charities instead:
- https://www.gofundme.com/f/WeCareAboutSyria
- https://www.gofundme.com/f/Burundi-Nutrition
- https://charity.gofundme.com/o/en/campaign/feedingyemen
- https://www.gofundme.com/f/6p8ea-give-ghanaian-orphans-the-gift-of-a-ride-to-school
