54d5c13d38
this will keep user's nvim configs cleaner, this is specifically a GitHub standard, not base Git
183 lines
8.5 KiB
Markdown
183 lines
8.5 KiB
Markdown
<h1 align="center">NvChad</h1>
|
|
|
|
<div align="center">
|
|
<a href="https://nvchad.github.io/">Home</a>
|
|
<span> • </span>
|
|
<a href="https://nvchad.github.io/getting-started/setup">Install</a>
|
|
<span> • </span>
|
|
<a href="https://nvchad.github.io/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">
|
|
|
|
[](https://lua.org)
|
|
|
|
</div>
|
|
|
|
<div align="center">
|
|
|
|
[]()
|
|
<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"
|
|
/>
|
|
[](https://discord.gg/gADmkJb9Fb)
|
|
[](https://github.com/neovim/neovim)
|
|
[](https://github.com/siduck76/NvChad/issues)
|
|
[](https://github.com/siduck76/NvChad/pulse)
|
|
|
|
</div>
|
|
|
|
## Showcase
|
|
|
|
<img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/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/all/rice%20flex/initialNvim1.png"><hr>
|
|
<img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/initialNvim.png"><hr>
|
|
|
|
## Theme Showcase
|
|
|
|
<details><summary> <b>Images (Click to expand!)</b></summary>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
## Very useful plugins used
|
|
|
|
<details><summary> <b>Images (Click to expand!)</b></summary>
|
|
|
|
<h3> Nvim-tree.lua </h3>
|
|
|
|
Fast file tree:
|
|
|
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/nvimtree.png"></kbd><hr>
|
|
|
|
<h3> Telescope-nvim </h3>
|
|
|
|
A fuzzy file finder, picker, sorter, previewer and much more:
|
|
|
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/tel.png"></kbd>
|
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/telmedia.png"></kbd><hr>
|
|
|
|
<h3> Indent-blankline.nvim </h3>
|
|
|
|
Adds indentline:
|
|
|
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/blanklineNvim.png"></kbd><hr>
|
|
|
|
<h3> Feline.nvim </h3>
|
|
|
|
Highly configurable statusline plugin:
|
|
|
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/statusline.png"></kbd><hr>
|
|
|
|
<h3> Nvim-bufferline.lua </h3>
|
|
|
|
Better tab implementation:
|
|
|
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/bufferline.png"></kbd><hr>
|
|
|
|
<h3> Nvim-web-devicons </h3>
|
|
|
|
Lua fork of Vim Devicons which offers more file icon customisability:
|
|
|
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/image.png"></kbd><hr>
|
|
|
|
<h3> Nvim-treesitter </h3
|
|
|
|
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/all/rice%20flex/woTree.png"></kbd><hr>
|
|
|
|
</details>
|
|
|
|
## 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 Lsp configuration with [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig).
|
|
- 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 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`.
|
|
|
|
<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
|
|
|
|
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, dont have access to proper education, comupters, basic health care facilities and more. Here are some charites and gofundme links you can donate to 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
|