You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
184 lines
8.5 KiB
Markdown
184 lines
8.5 KiB
Markdown
3 years ago
|
<h1 align="center">NvChad</h1>
|
||
3 years ago
|
|
||
3 years ago
|
<div align="center">
|
||
3 years ago
|
<a href="https://nvchad.github.io/">Home</a>
|
||
3 years ago
|
<span> • </span>
|
||
3 years ago
|
<a href="https://nvchad.github.io/getting-started/setup">Install</a>
|
||
3 years ago
|
<span> • </span>
|
||
3 years ago
|
<a href="https://nvchad.github.io/contribute">Contribute</a>
|
||
3 years ago
|
<span> • </span>
|
||
3 years ago
|
<a href="https://github.com/siduck76/NvChad#gift_heart-support">Support</a>
|
||
3 years ago
|
<span> • </span>
|
||
|
<a href="https://github.com/siduck76/NvChad/wiki/Chad-user-configs">Extras</a>
|
||
|
<p></p>
|
||
|
</div>
|
||
|
|
||
3 years ago
|
<div align="center">
|
||
3 years ago
|
|
||
3 years ago
|
[![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)](https://lua.org)
|
||
3 years ago
|
|
||
3 years ago
|
</div>
|
||
3 years ago
|
|
||
3 years ago
|
<div align="center">
|
||
3 years ago
|
|
||
3 years ago
|
[![Super Linter](https://img.shields.io/github/workflow/status/siduck76/NvChad/Super-Linter/main?style=flat-square&logo=github&label=Build&color=green)]()
|
||
3 years ago
|
<a href="https://github.com/siduck76/NvChad"
|
||
|
><img
|
||
3 years ago
|
src="https://img.shields.io/github/repo-size/siduck76/NvChad?style=flat-square&label=Repo"
|
||
3 years ago
|
alt="GitHub repository size"
|
||
|
/></a>
|
||
|
<a href="https://github.com/siduck76/NvChad/blob/main/LICENSE"
|
||
|
><img
|
||
3 years ago
|
src="https://img.shields.io/github/license/siduck76/NvChad?style=flat-square&logo=GNU&label=License"
|
||
3 years ago
|
alt="License"
|
||
|
/>
|
||
3 years ago
|
[![Discord](https://img.shields.io/discord/869557815780470834?color=738adb&label=Discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/gADmkJb9Fb)
|
||
3 years ago
|
[![Neovim Minimum Version](https://img.shields.io/badge/Neovim-0.5+-blueviolet.svg?style=flat-square&logo=Neovim&logoColor=white)](https://github.com/neovim/neovim)
|
||
|
[![GitHub Issues](https://img.shields.io/github/issues/siduck76/NvChad.svg?style=flat-square&label=Issues&color=fc0330)](https://github.com/siduck76/NvChad/issues)
|
||
3 years ago
|
[![Last Commit](https://img.shields.io/github/last-commit/siduck76/NvChad.svg?style=flat-square&label=Last%20Commit&color=58eb34)](https://github.com/siduck76/NvChad/pulse)
|
||
|
|
||
3 years ago
|
</div>
|
||
3 years ago
|
|
||
3 years ago
|
## Showcase
|
||
|
|
||
3 years ago
|
<img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/dashboard-nvim.png"><hr>
|
||
3 years ago
|
<img src="https://cdn.discordapp.com/attachments/610012460828852229/853933487295299584/unknown.png"><hr>
|
||
3 years ago
|
<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>
|
||
4 years ago
|
|
||
3 years ago
|
## Theme Showcase
|
||
3 years ago
|
|
||
3 years ago
|
<details><summary> <b>Images (Click to expand!)</b></summary>
|
||
3 years ago
|
|
||
|
![onedark](https://user-images.githubusercontent.com/59060246/130129880-59ab1ad5-9aa6-4f50-9ddd-d8dde0c16257.png)
|
||
|
![nord](https://user-images.githubusercontent.com/59060246/130129890-c01117df-ac3d-40dd-b95d-2681c2461bb4.png)
|
||
|
![gruvchad](https://user-images.githubusercontent.com/59060246/130129897-a68b1585-f42d-4325-8482-102dd2fe1e9e.png)
|
||
|
![everforest](https://user-images.githubusercontent.com/59060246/130129901-5e582f3e-b776-4d0c-9790-be5ae738b5a8.png)
|
||
|
|
||
3 years ago
|
</details>
|
||
|
|
||
3 years ago
|
## Very useful plugins used
|
||
4 years ago
|
|
||
3 years ago
|
<details><summary> <b>Images (Click to expand!)</b></summary>
|
||
|
|
||
|
<h3> Nvim-tree.lua </h3>
|
||
4 years ago
|
|
||
3 years ago
|
Fast file tree:
|
||
4 years ago
|
|
||
3 years ago
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/nvimtree.png"></kbd><hr>
|
||
4 years ago
|
|
||
3 years ago
|
<h3> Telescope-nvim </h3>
|
||
4 years ago
|
|
||
|
A fuzzy file finder, picker, sorter, previewer and much more:
|
||
3 years ago
|
|
||
3 years ago
|
<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>
|
||
4 years ago
|
|
||
3 years ago
|
<h3> Indent-blankline.nvim </h3>
|
||
4 years ago
|
|
||
3 years ago
|
Adds indentline:
|
||
|
|
||
3 years ago
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/blanklineNvim.png"></kbd><hr>
|
||
4 years ago
|
|
||
3 years ago
|
<h3> Feline.nvim </h3>
|
||
4 years ago
|
|
||
3 years ago
|
Highly configurable statusline plugin:
|
||
3 years ago
|
|
||
3 years ago
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/statusline.png"></kbd><hr>
|
||
4 years ago
|
|
||
3 years ago
|
<h3> Nvim-bufferline.lua </h3>
|
||
4 years ago
|
|
||
3 years ago
|
Better tab implementation:
|
||
|
|
||
3 years ago
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/bufferline.png"></kbd><hr>
|
||
4 years ago
|
|
||
3 years ago
|
<h3> Nvim-web-devicons </h3>
|
||
3 years ago
|
|
||
3 years ago
|
Lua fork of Vim Devicons which offers more file icon customisability:
|
||
|
|
||
3 years ago
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/image.png"></kbd><hr>
|
||
3 years ago
|
|
||
3 years ago
|
<h3> Nvim-treesitter </h3
|
||
3 years ago
|
|
||
3 years ago
|
Better syntax highlighting for programming languages (NvChad by default comes with Lua/bash treesitter parsers).
|
||
|
|
||
|
Without/with Treesitter:
|
||
4 years ago
|
|
||
3 years ago
|
<kbd><img src="https://raw.githubusercontent.com/siduck76/dotfiles/all/rice%20flex/woTree.png"></kbd><hr>
|
||
3 years ago
|
|
||
|
</details>
|
||
4 years ago
|
|
||
3 years ago
|
## Credits
|
||
3 years ago
|
|
||
3 years ago
|
- [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.
|
||
3 years ago
|
|
||
3 years ago
|
## Features
|
||
|
|
||
3 years ago
|
- 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) .
|
||
3 years ago
|
- NeoVim Lsp configuration with [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig).
|
||
3 years ago
|
- 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
|
||
3 years ago
|
|
||
3 years ago
|
To everyone who thinks that NvChad is bloat: Bloat means different things to everyone.
|
||
|
|
||
3 years ago
|
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`.
|
||
3 years ago
|
|
||
|
<img src = "https://chadpaste.com/f/kdmxdabxbk.png">
|
||
|
|
||
4 years ago
|
# TODO
|
||
|
|
||
3 years ago
|
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:
|
||
3 years ago
|
|
||
3 years ago
|
- Improving base plugins configurations
|
||
|
- Debloating the config.
|
||
|
- Adding more themes.
|
||
4 years ago
|
|
||
3 years ago
|
## Try NvChad in a Docker container
|
||
3 years ago
|
|
||
3 years ago
|
This will leave your current Neovim configuration untouched. Once you exit Neovim, the image is deleted.
|
||
3 years ago
|
|
||
|
```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
|
||
|
'
|
||
|
```
|
||
|
|
||
3 years ago
|
## Chadributors
|
||
3 years ago
|
|
||
3 years ago
|
<a href="https://github.com/NvChad/NvChad/graphs/contributors">
|
||
|
<img src="https://contrib.rocks/image?repo=siduck76/NvChad"/>
|
||
3 years ago
|
</a>
|
||
|
|
||
3 years ago
|
## Warning
|
||
3 years ago
|
|
||
3 years ago
|
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.
|
||
3 years ago
|
|
||
|
## :gift_heart: Support
|
||
|
|
||
3 years ago
|
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:
|
||
3 years ago
|
|
||
|
- 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
|