nvchad/README.md

8.4 KiB

NvChad

Lua

Showcase





Theme Showcase (Click to expand!)

onedark nord gruvchad everforest

Very useful plugins used

Nvim-tree.lua

Fast file tree:


Telescope-nvim

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



Indent-blankline.nvim

Adds indentline:


Feline.nvim

Highly configurable statusline plugin:



Nvim-bufferline.lua

Better tab implementation:


Nvim-web-devicons

Lua fork of Vim Devicons which offers more file icon customisability:


Nvim-treesitter

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

Without/with Treesitter:


Credits

  • 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

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.

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.

  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

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.

💝 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 and plugin developers, I don't feel comfortable taking donations for myself, so donate to one of these charities instead: