2021-06-26 08:12:02 +01:00
< h1 align = "center" > NvChad< / h1 >
2021-05-17 21:14:10 +01:00
2021-06-26 08:03:02 +01:00
< div align = "center" >
2021-08-19 05:55:22 +01:00
< a href = "https://nvchad.netlify.app/" > Home< / a >
2021-06-26 08:03:02 +01:00
< span > • < / span >
2021-08-22 00:26:48 +01:00
< a href = "https://nvchad.netlify.app/getting-started/setup" > Install< / a >
2021-06-26 08:03:02 +01:00
< span > • < / span >
2021-08-23 01:44:33 +01:00
< a href = "https://nvchad.netlify.app/contribute" > Contribute< / a >
2021-06-26 08:03:02 +01:00
< span > • < / span >
2021-06-26 08:19:12 +01:00
< a href = "https://github.com/siduck76/NvChad#gift_heart-support" > Support< / a >
2021-06-26 08:03:02 +01:00
< span > • < / span >
< a href = "https://github.com/siduck76/NvChad/wiki/Chad-user-configs" > Extras< / a >
< p > < / p >
< / div >
2021-07-01 16:06:57 +01:00
< div align = "center" >
2021-07-02 08:53:01 +01:00
[![Lua ](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua )]()
2021-07-02 08:51:18 +01:00
< / div >
2021-07-02 03:06:20 +01:00
2021-07-02 08:51:18 +01:00
< div align = "center" >
2021-07-02 07:27:02 +01:00
[![Super Linter ](https://img.shields.io/github/workflow/status/siduck76/NvChad/Super-Linter/main?style=flat-square&logo=github&label=Build&color=green )]()
2021-06-29 04:22:28 +01:00
< a href = "https://github.com/siduck76/NvChad"
>< img
2021-07-02 07:27:02 +01:00
src="https://img.shields.io/github/repo-size/siduck76/NvChad?style=flat-square& label=Repo"
2021-06-29 04:22:28 +01:00
alt="GitHub repository size"
/>< / a >
< a href = "https://github.com/siduck76/NvChad/blob/main/LICENSE"
>< img
2021-07-02 07:27:02 +01:00
src="https://img.shields.io/github/license/siduck76/NvChad?style=flat-square& logo=GNU& label=License"
2021-06-29 04:22:28 +01:00
alt="License"
/>
2021-08-08 05:03:57 +01:00
[![Discord ](https://img.shields.io/discord/869557815780470834?color=738adb&label=Discord&logo=discord&logoColor=white&style=flat-square )](https://discord.gg/gADmkJb9Fb)
2021-07-02 07:27:02 +01:00
[![Neovim Minimum Version ](https://img.shields.io/badge/Neovim-0.5+-blueviolet.svg?style=flat-square&logo=Neovim&logoColor=white )](https://github.com/neovim/neovim)
[![GitHub Issues ](https://img.shields.io/github/issues/siduck76/NvChad.svg?style=flat-square&label=Issues&color=fc0330 )](https://github.com/siduck76/NvChad/issues)
2021-07-05 11:00:53 +01:00
[![Last Commit ](https://img.shields.io/github/last-commit/siduck76/NvChad.svg?style=flat-square&label=Last%20Commit&color=58eb34 )](https://github.com/siduck76/NvChad/pulse)
2021-07-02 03:06:20 +01:00
2021-07-05 11:00:53 +01:00
< / div >
2021-07-01 14:45:29 +01:00
2021-08-18 14:35:51 +01:00
# Showcase
2021-06-14 07:34:12 +01:00
< img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/dashboard-nvim.png" > < hr >
2021-08-18 14:35:51 +01:00
< img src = "https://cdn.discordapp.com/attachments/610012460828852229/853933487295299584/unknown.png" > < hr >
2021-06-14 07:15:40 +01:00
< img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim1.png" > < hr >
2021-03-26 05:02:04 +00:00
< img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim.png" > < hr >
2021-03-10 09:05:16 +00:00
2021-08-19 20:10:45 +01:00
# Some theme showcases :D
![onedark ](https://user-images.githubusercontent.com/59060246/130129880-59ab1ad5-9aa6-4f50-9ddd-d8dde0c16257.png )
![nord ](https://user-images.githubusercontent.com/59060246/130129890-c01117df-ac3d-40dd-b95d-2681c2461bb4.png )
![gruvchad ](https://user-images.githubusercontent.com/59060246/130129897-a68b1585-f42d-4325-8482-102dd2fe1e9e.png )
![everforest ](https://user-images.githubusercontent.com/59060246/130129901-5e582f3e-b776-4d0c-9790-be5ae738b5a8.png )
2021-09-02 19:40:26 +01:00
# Very Very Useful Lua plugins used in my config
2021-03-14 16:48:48 +00:00
2021-06-26 08:03:02 +01:00
#### Lspkind-nvim
2021-03-26 05:02:04 +00:00
2021-08-19 14:05:56 +01:00
This tiny plugin adds vscode-like pictograms to neovim built-in lsp completion items:
2021-03-14 16:48:48 +00:00
2021-03-26 05:02:04 +00:00
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/lspkind.png" > < / kbd > < hr >
2021-03-14 16:48:48 +00:00
2021-06-26 08:03:02 +01:00
#### Nvim-tree.lua
2021-03-26 05:02:04 +00:00
2021-08-19 14:05:56 +01:00
fast file tree:
2021-03-26 05:02:04 +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 08:03:02 +01:00
### Telescope-nvim
2021-03-26 05:02:04 +00:00
A fuzzy file finder, picker, sorter, previewer and much more:
< 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-06-26 08:03:02 +01:00
### Indent-blankline.nvim
2021-03-26 05:02:04 +00:00
2021-08-19 14:05:56 +01:00
adds indentline:
2021-03-26 05:02:04 +00:00
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/blanklineNvim.png" > < / kbd >
2021-03-13 08:04:10 +00:00
2021-06-26 08:03:02 +01:00
### Galaxyline
2021-03-26 05:02:04 +00:00
fastest statusline plugin I've used so far:
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/statusline.png" > < / kbd > < hr >
2021-06-26 08:03:02 +01:00
### Nvim-bufferline.lua
2021-03-26 05:02:04 +00:00
2021-06-26 08:03:02 +01:00
As a top tabline like thing which lets me handle tabs and buffers like switching , sorting and closing them etc.
2021-03-26 05:02:04 +00:00
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/bufferline.png" > < / kbd >
2021-06-26 08:03:02 +01:00
### Nvim-web-devicons
2021-08-19 14:05:56 +01:00
Lua fork of vim devicons which lets me change icons of filetypes:
2021-06-26 08:03:02 +01:00
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/image.png" > < / kbd >
### Nvim-treesitter
2021-09-02 19:40:26 +01:00
Better syntax highlighting for programming languages ( NvChad by default comes with Lua/bash treesitter parsers ).
2021-03-13 03:05:22 +00:00
2021-08-19 14:05:56 +01:00
without / with Treesitter:
2021-03-26 05:02:04 +00:00
< kbd > < img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/woTree.png" > < / kbd >
2021-06-26 13:21:11 +01:00
# Credits
2021-09-02 19:40:26 +01:00
- [Elianiva ](https://github.com/elianiva ) helped me with neovim Lua related issues many times, NvChad wouldnt exist without his help at all!
2021-08-19 16:38:47 +01:00
- @lorvethe for making NvChad logo!
2021-06-26 13:21:11 +01:00
2021-03-19 12:34:18 +00:00
# Features
2021-03-26 05:02:04 +00:00
- File navigation with Nvimtree
2021-06-26 08:03:02 +01:00
- Using plugins that are mouse friendly
2021-07-18 19:05:25 +01:00
- Beautiful inbuilt themes
- lazy loading 100% of plugins
2021-08-19 14:03:55 +01:00
- managing tabs, buffers with bufferline
2021-03-19 12:34:18 +00:00
- autosave
2021-08-19 14:03:55 +01:00
- icons on nvimtree, telescope, bufferline/statusline and almost everywhere! with nvim-web-devicons
- minimal status line (galaxyline)
2021-06-14 07:15:40 +01:00
- gitsigns (colored bars for git in my config)
2021-07-18 19:05:25 +01:00
- nvim-lspconfig for nvim-lsp configuration
- lspInstall for installing lsp servers easily
2021-03-26 05:02:04 +00:00
- nvim-compe for autocompletion
2021-03-19 12:34:18 +00:00
- lspkind to show pictograms on autocompletion items
2021-08-19 14:03:55 +01:00
- telescope for file finding, picking, previewing (files and even images)
2021-03-26 05:02:04 +00:00
- nvim-treesitter for syntax highlighting
2021-07-18 19:05:25 +01:00
- nvim-autopairs for autolosing braces and stuffs
2021-08-19 14:03:55 +01:00
- neoformat for prettifying/formatting code
2021-03-19 12:34:18 +00:00
- packer.nvim as package manager
2021-03-31 02:23:59 +01:00
- indent-blankline.Nvim for indentlines
2021-03-31 03:00:33 +01:00
- smooth scrolling
2021-07-18 19:05:25 +01:00
- luasnip for snippet plugin and snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets)
2021-08-19 14:03:55 +01:00
- Distraction free modes (modes in which statusline, tabline etc. stuff get disabled so its just the text visible in the buffer similar to goyo.vim)
- Code formatting/prettifying
2021-07-18 19:05:25 +01:00
- gitsigns for git diffs
2021-05-05 02:21:04 +01:00
2021-07-14 02:24:14 +01:00
# Bloat
2021-08-19 14:00:23 +01:00
- To all those who think this is probably bloated, sure it is. Bloat means different to everyone. NvChad has like 30 ~ plugins but that doesn't mean those plugins are compromising neovim's speed, snappiness, or making it slow. No matter how many plugins I'd add on NvChad, it wouldn't compromise speed/snappiness/make it slow or whatever since it uses packer.nvim as plugin manager. packer.nvim lets you lazy load plugins i.e. loading plugins on certain events, mappings, sequentially loading them, etc, thus loading them only when needed. I have lazy loaded all the plugins so most plugins aren't loaded by default, hence not affecting neovim's startup/launch time.
2021-07-14 02:24:14 +01:00
< img src = "https://chadpaste.com/f/kdmxdabxbk.png" >
2021-03-26 05:02:04 +00:00
# TODO
2021-08-19 13:46:22 +01:00
It would be nice if NvChad focuses on existing plugins and config before adding new things. Some plugins like whichkey, telescope and treesitter still have basic configs! Also adding new features that'd make NvChad slow or its startup time slow wouldn't be encouraged. If that feature is really needed then it'll be mentioned in the wiki with its config.
2021-06-15 19:09:40 +01:00
2021-08-04 04:09:43 +01:00
- Debloat the config.
2021-08-19 17:58:55 +01:00
- Make NvChad more and more faster (reduce startup time as low as possible).
2021-04-14 02:59:42 +01:00
- Add more themes.
2021-03-26 05:02:04 +00:00
2021-08-22 15:09:45 +01:00
# Try in docker
Try NvChad in a docker container. This will leave your current Neovim configuration untouched. Once you exit Neovim, the image is deleted.
```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
'
```
# Chad contributors
2021-08-14 11:42:44 +01:00
2021-08-19 13:16:51 +01:00
< a href = "https://github.com/NvChad/NvChad/graphs/contributors" >
2021-08-14 11:42:44 +01:00
< img src = "https://contrib.rocks/image?repo=siduck76/NvChad" / >
< / a >
2021-08-20 17:32:41 +01:00
## Warning
2021-06-15 19:09:40 +01:00
2021-08-20 17:32:41 +01:00
I get hearings from some plugin devs that nvchad users bring issues on discourse/reddit/matrix/gh repos etc. Please dont do that :/ . Bring NvChad related issues here ONLY and dont ever bother plugin devs, THIS IS A CLEAR WARNING! 😠
2021-06-15 19:09:40 +01:00
2021-08-20 17:32:41 +01:00
## :gift_heart: Support
2021-06-15 19:09:40 +01:00
2021-08-22 19:57:18 +01:00
I (siduck76) would happily accept donations but I would be upset and feel bad since Im not the only one who has worked on NvChad. NvChad has been made possible by many contributors so dividing the donations for just me feels very bad and thanks to all the plugin creators once again :'). If you enjoy using NvChad and would like to show your support truly and show your appreciation to my work then try to be a better you! Help the needy people whenever possible (in real life), do some charity.Be nice to your parents and loved ones.Do not be rude , always try to be helpful / caring to one another, stray animals. Its easier to hate now and harder to care , hate used to be rare but now you see it everywhere. Please be respectful to any software/work done by other people rather than making fun of them. Do not compare software (In a bad way). Im grateful to be even able to use neovim! But cant still be fully happy when I think there are people who barely get food to eat, starve for weeks, dont have access to proper education, comupters, basic health care facilities etc.
2021-08-17 15:11:43 +01:00
2021-08-20 17:32:41 +01:00
The following links are some donation (gofundme) links for supporting needy people. Feel free to donate if you can :
2021-08-17 15:11:43 +01:00
2021-08-20 17:33:25 +01:00
- 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