mirror of https://github.com/NvChad/NvChad synced 2023-10-04 09:45:13 -05:00

History

siduck 7e3a4e9a9f Edited the support section		2022-05-04 17:22:18 +05:30
..
ISSUE_TEMPLATE	Update config.yml	2021-07-01 18:48:31 +05:30
PULL_REQUEST_TEMPLATE	chore: Dev pr template (#495 )	2021-09-27 23:01:45 +10:00
workflows	Delete format.yml	2021-12-07 14:05:58 +05:30
CONTRIBUTING.md	chore: fix typos	2022-01-04 06:07:38 +05:30
FUNDING.yml	Create FUNDING.yml	2022-05-04 17:06:14 +05:30
README.md	Edited the support section	2022-05-04 17:22:18 +05:30

README.md

NvChad

Home • Install • Contribute • Support • Extras

Showcase

Theme Showcase

Images (Click to expand!)

Very useful plugins used

Images (Click to expand!)

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 wouldn't exist without his help at all.
@lorvethe for making the beautiful NvChad logo.

Features

Many beautiful themes to choose from.
Fast plugin loading.
File navigation with nvim-tree.lua.
Managing tabs, buffers with bufferline.nvim.
Beautiful and configurable icons with nvim-web-devicons.
Pretty and functional statusline with feline.nvim.
Git diffs and more with gitsigns.nvim .
NeoVim Lsp configuration with nvim-lspconfig.
Autocompletion with nvim-cmp.
File searching, previewing image and text files and more with telescope.nvim.
Syntax highlighting with nvim-treesitter.
Autoclosing braces and html tags with nvim-autopairs.
Indentlines with indent-blankline.nvim.
Useful snippets with 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 the Packer plugin manager. Packer.nvim allows you to lazy load plugins, meaning they only get loaded when absolutely required. Furthermore, you can disable plugins you don't use in chadrc.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

I'm (@siduck) really very sorry to remove the previous charity links but I had to do it for various reasons. A lot has been going here regarding financial issues and I do need some support if it's possible from your end. I haven't graduated yet and it would be great to earn some stuff as that'd help me with daily minor expenses. If you like NvChad and would like to support it via donation then I'll gladly accept it. Dont worry! NvChad will still stay alive & active without your donations! I will remove the sponsor button and re-add the charity links once I get a job, probably a year or two.