nvchad/README.md

<h1 align="center">NvChad</h1> 

<div align="center">
	<a href="https://nvchad.netlify.app/">Home</a>
  <span> • </span>
    	<a href="https://nvchad.netlify.app/getting-started/setup">Install</a>
  <span> • </span>
       	<a href="https://nvchad.netlify.app/contribute">Contribute</a>
  <span> • </span>
	<a href="https://github.com/siduck76/NvChad#gift_heart-support">Support</a>
  <span> • </span>
      	<a href="https://github.com/siduck76/NvChad/wiki/Chad-user-configs">Extras</a>
  <p></p>
</div>

<div align="center">
	
[![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)](https://lua.org)
	
</div>

<div align="center">
	
[![Super Linter](https://img.shields.io/github/workflow/status/siduck76/NvChad/Super-Linter/main?style=flat-square&logo=github&label=Build&color=green)]()
<a href="https://github.com/siduck76/NvChad"
        ><img
            src="https://img.shields.io/github/repo-size/siduck76/NvChad?style=flat-square&label=Repo"
            alt="GitHub repository size"
    /></a>
      <a href="https://github.com/siduck76/NvChad/blob/main/LICENSE"
        ><img
            src="https://img.shields.io/github/license/siduck76/NvChad?style=flat-square&logo=GNU&label=License"
            alt="License"
    />
[![Discord](https://img.shields.io/discord/869557815780470834?color=738adb&label=Discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/gADmkJb9Fb)
[![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)
[![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) 
	      
  </div>

## Showcase

<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>

<details><summary><h2>Theme Showcase (Click to expand!)</h2></summary>

![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)

</details>

## Very useful plugins used

### Nvim-tree.lua

Fast file tree:

<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png"></kbd><hr>

### Telescope-nvim

A fuzzy file finder, picker, sorter, previewer and much more:

<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>

### Indent-blankline.nvim

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>

### Feline.nvim

Highly configurable statusline plugin:

<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>

### Nvim-bufferline.lua

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>

### Nvim-web-devicons

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>

### Nvim-treesitter

Better syntax highlighting for programming languages (NvChad by default comes with Lua/bash treesitter parsers).

Without/with Treesitter:

<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>

## Credits

- [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.

## Features

- 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
	
To everyone who thinks that NvChad is bloat: Bloat means different things to everyone.

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`.

<img src = "https://chadpaste.com/f/kdmxdabxbk.png">

# TODO

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:

- Improving base plugins configurations
- Debloating the config.
- Adding more themes.

## 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
    '
```

## Chadributors

<a href="https://github.com/NvChad/NvChad/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=siduck76/NvChad"/>
</a>

## Warning

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.

## :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