mirror of https://github.com/CompeyDev/my-nvim-setup.git synced 2024-12-12 21:00:38 +00:00

Custom neovim setup, based on hardhacker.

Find a file

Matt Bailey 6f65cffaa1 chore: add spell directory to gitignore		2022-01-08 07:06:04 +05:30
.github	readme badge : update nvim version	2022-01-04 06:44:45 +05:30
examples	rm hooks	2022-01-07 19:58:05 +05:30
lua	rm hooks	2022-01-07 19:58:05 +05:30
.gitignore	chore: add spell directory to gitignore	2022-01-08 07:06:04 +05:30
.stylua.toml	chore: stylua formatting update (#261 )	2021-08-16 13:19:09 +05:30
init.lua	load custom/init.lua at last \| fix (#694 )	2022-01-07 07:30:55 +05:30
LICENSE	Initial commit	2021-03-07 20:03:18 +05:30

.github/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 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

I would happily accept donations but would feel awful since I'm not the only one who has worked on NvChad. The project has only been made possible by the many great contributors and plugin developers, thus taking the donations just for me feels unjustified. If you enjoy using NvChad and would like to show your support then try to be a better you! Help the people in need whenever possible and do charity work. Be nice to loved ones and strangers alike. Do not be rude, always try to be helpful and caring for one another. It's easy to hate but hard to care. Be respectful to any software/work done by other people rather than making fun of them. Do not compare software (In a bad way). I'm grateful to even be able to use NeoVim! But I still cannot be fully happy when I know that there are people who barely have any food to eat, starve for weeks, don't have access to proper education, computers, basic health care facilities and more. Here are some charities and gofundme links you can donate to instead: