mirror of https://github.com/NvChad/NvChad.git synced 2024-11-04 12:00:29 +00:00

An attempt to make neovim cli functional like an IDE while being very beautiful, blazing fast startuptime ~ 20ms to 70ms

chad charity dotfiles foss ide lua neovim neovim-config neovim-configuration neovim-dotfiles neovim-lua neovim-setup nvim nvim-configs rice ricing telescope vim vimrc vscode

Go to file

siduck 00be26275e keep some gitsigns mappings only \| rm 0.7v related stuff		2022-10-07 19:26:07 +05:30
.github	chore: update issue template	2022-07-27 18:14:03 +05:30
lua	keep some gitsigns mappings only \| rm 0.7v related stuff	2022-10-07 19:26:07 +05:30
.gitignore	keep ftplugin folder git-ignored \| #1510	2022-08-25 18:01:45 +05:30
.stylua.toml	set shiftwidth to 2 \| format all files	2022-07-22 16:00:00 +00:00
init.lua	install binaries from mason.nvm & tsparsers automatically after nvchad install	2022-09-11 01:07:44 +05:30
LICENSE	Initial commit	2021-03-07 20:03:18 +05:30

.github/README.md

NvChad

Home • Install • Contribute • Support • Features

Showcase

( Zoom in the screenshot )

What is it?

NvChad is a neovim config written in lua aiming to provide a base configuration with very beautiful UI and blazing fast startuptime (around 0.02 secs ~ 0.07 secs). We tweak UI plugins such as telescope, nvim-tree, bufferline etc well to provide an aesthetic UI experience.
Lazy loading is done 93% of the time meaning that plugins will not be loaded by default, they will be loaded only when required also at specific commands, events etc. This lowers the startuptime and it was like 0.07~ secs tested on an old pentium machine 1.4ghz + 4gb ram & HDD.
NvChad isnt a framework! Its supposed to be used as a "base" config, so users could tweak the defaults well, can also remove the things they dont like in the default config and build their config on top of it. Users can tweak the entire default config while staying in their custom config (lua/custom dir). This is the control center of the user's config and gitignored so the users can stay update to-date with NvChad's latest config (main branch) while still controlling it with their chadrc (file that controls entire custom dir)

Theme Showcase

Images (Click to expand!)

(Note: these are just 4-5 themes, NvChad has around 27+ themes)

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:

Our own statusline written from scratch

NvChad UI

Tabufline (our own pertab bufferline)

Nvim-web-devicons

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

Nvim-treesitter

NeoVim Treesitter configurations and abstraction layer. We mostly use this for syntax highlighting. The pretty syntax highlighting you see in all of our screenshots has gotten possible due to treesitter

Plugins list

Many beautiful themes, theme toggler by our base46 plugin
Inbuilt terminal toggling & management with Nvterm
NvChad updater, hide & unhide terminal buffers with NvChad extensions
Lightweight & performant ui plugin with NvChad UI
File navigation with nvim-tree.lua
Managing tabs, buffers with bufferline.nvim
Beautiful and configurable icons with nvim-web-devicons
Git diffs and more with gitsigns.nvim
NeoVim Lsp configuration with nvim-lspconfig and mason.nvim
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 friendly snippets + LuaSnip.
Popup mappings keysheet whichkey.nvim

History

I (@siduck i.e creator of NvChad) in my initial days of learning to program wanted a lightweight IDE for writing code, I had a very low end system which was like 1.4ghz pentium + 4gb ram & HDD. I was into web dev stuff so many suggested me to use vscode but that thing was very heavy on my system, It took more ram than my browser! ( minimal ungoogled chromium ) so I never tried it again, sublime text was nice but the fear of using proprietary software XD for a linux user bugged me a lot. Then I tried doom-emacs which looked pretty but it was slow and I was lost within its docs, I tried lunarvim but too lazy to read the docs. Doom-emacs and lunarvim inspired me to make a config which is the prettiest + very fast and simple.
I'm decent at ricing i.e customizing system and making it look pretty so I posted my neovim rice on neovim subreddit, my neovim-dotfiles github repo blew up and then I had to come up with a name, I was amazed by the chad meme lol so I put NvChad as the name, the chad word in here doesnt literally mean the chad guy but in the sense such as chad linux vs windows i.e meaning superior, best etc. NvChad was made for my personal use but it gained some popularity which inspired me to make a public config i.e config usable by many and less hassle to update as everyone's going to use the same base config (NvChad) with their custom modifications (which are gitignored so that wont mess up), without the custom config stuff users would have to keep a track of every commit and copy paste git diffs to manually update nvchad.

💝 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 & appreciate 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.

Credits

Elianiva helped me with NeoVim Lua related issues many times, NvChad wouldn't exist without his help at all as he helped me in my initial neovim journey!
@lorvethe for making the beautiful NvChad logo.