neovim-config/README.md

179 lines
9.2 KiB
Markdown
Raw Normal View History

2021-06-26 07:12:02 +00:00
<h1 align="center">NvChad</h1>
2021-06-26 07:03:02 +00:00
<div align="center">
<a href="https://github.com/siduck76/NvChad/wiki#clone-my-setup">Home</a>
<span></span>
<a href="https://github.com/siduck76/NvChad/wiki#clone-my-setup">Install</a>
<span></span>
<a href="https://github.com/siduck76/NvChad#contribute">Contribute</a>
<span></span>
2021-06-26 07:19:12 +00:00
<a href="https://github.com/siduck76/NvChad#gift_heart-support">Support</a>
2021-06-26 07:03:02 +00:00
<span></span>
<a href="https://github.com/siduck76/NvChad/wiki/Chad-user-configs">Extras</a>
<p></p>
</div>
2021-07-01 15:06:57 +00:00
<div align="center">
2021-07-02 07:53:01 +00:00
[![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)]()
2021-07-02 07:51:18 +00:00
</div>
2021-07-02 07:51:18 +00:00
<div align="center">
[![Super Linter](https://img.shields.io/github/workflow/status/siduck76/NvChad/Super-Linter/main?style=flat-square&logo=github&label=Build&color=green)]()
2021-06-29 03:22:28 +00:00
<a href="https://github.com/siduck76/NvChad"
><img
src="https://img.shields.io/github/repo-size/siduck76/NvChad?style=flat-square&label=Repo"
2021-06-29 03:22:28 +00:00
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"
2021-06-29 03:22:28 +00:00
alt="License"
/>
[![Discord](https://img.shields.io/discord/869557815780470834?color=738adb&label=Discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/gADmkJb9Fb)
[![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)
2021-07-05 10:00:53 +00:00
[![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)
2021-07-05 10:00:53 +00:00
</div>
2021-06-26 07:18:04 +00:00
<img src ="https://cdn.discordapp.com/attachments/610012460828852229/853933487295299584/unknown.png"><hr>
2021-06-14 06:34:12 +00:00
<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/dashboard-nvim.png"><hr>
2021-06-14 06:15:40 +00:00
<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim1.png"><hr>
<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim.png"><hr>
2021-06-15 18:22:11 +00:00
<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimRice2.png"><hr>
2021-03-10 09:05:16 +00:00
2021-06-26 07:03:02 +00:00
# Very Very Useful lua plugins used in my config
2021-06-26 07:03:02 +00:00
#### Lspkind-nvim
2021-03-15 10:55:25 +00:00
This tiny plugin adds vscode-like pictograms to neovim built-in lsp completion items :
<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/lspkind.png"></kbd><hr>
2021-06-26 07:03:02 +00:00
#### Nvim-tree.lua
fast file tree :
<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png"></kbd><hr>
2021-03-13 08:04:10 +00:00
2021-06-26 07:03:02 +00:00
### Telescope-nvim
A fuzzy file finder, picker, sorter, previewer and much more:
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/tel.png"></kbd>
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/telmedia.png"></kbd><hr>
2021-06-26 07:03:02 +00:00
### Indent-blankline.nvim
adds indentline :
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/blanklineNvim.png"></kbd>
2021-03-13 08:04:10 +00:00
2021-06-26 07:03:02 +00:00
### Galaxyline
fastest statusline plugin I've used so far:
<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/statusline.png"></kbd><hr>
2021-06-26 07:03:02 +00:00
### Nvim-bufferline.lua
2021-06-26 07:03:02 +00:00
As a top tabline like thing which lets me handle tabs and buffers like switching , sorting and closing them etc.
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/bufferline.png"></kbd>
2021-06-26 07:03:02 +00:00
### Nvim-web-devicons
Lua fork of vim devicons which lets me change icons of filetypes
2021-06-26 07:03:02 +00:00
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/image.png"></kbd>
### Nvim-treesitter
Better syntax highlighting for programming languages ( my config just has html,css,js support for now ).
2021-03-13 03:05:22 +00:00
2021-04-29 15:25:03 +00:00
without / with Treesitter :
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/woTree.png"></kbd>
2021-06-26 12:21:11 +00:00
# Credits
[Elianiva](https://github.com/elianiva) helped me with neovim lua related issues many times, NvChad wouldnt exist without his help at all!
2021-03-19 12:34:18 +00:00
# Features
- File navigation with Nvimtree
2021-06-26 07:03:02 +00:00
- Using plugins that are mouse friendly
2021-07-18 18:05:25 +00:00
- Beautiful inbuilt themes
- lazy loading 100% of plugins
2021-06-26 07:03:02 +00:00
- managing tabs , buffers with bufferline
2021-03-19 12:34:18 +00:00
- autosave
- icons on nvimtree , telescope , bufferline/statusline and almost everywhere! with nvim-web-devicons
- minimal status line ( galaxyline)
2021-06-14 06:15:40 +00:00
- gitsigns (colored bars for git in my config)
2021-07-18 18:05:25 +00:00
- nvim-lspconfig for nvim-lsp configuration
- lspInstall for installing lsp servers easily
- nvim-compe for autocompletion
2021-03-19 12:34:18 +00:00
- lspkind to show pictograms on autocompletion items
- telescope for file finding , picking , previewing (files and even images)
- nvim-treesitter for syntax highlighting
2021-07-18 18:05:25 +00:00
- nvim-autopairs for autolosing braces and stuffs
- neoformat for prettifying / formatting code
2021-03-19 12:34:18 +00:00
- packer.nvim as package manager
2021-03-31 01:23:59 +00:00
- indent-blankline.Nvim for indentlines
2021-03-31 02:00:33 +00:00
- smooth scrolling
2021-07-18 18:05:25 +00:00
- luasnip for snippet plugin and snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets)
- Distraction free modes ( modes in which statusline , tabline etc stuff get disabled so its just the text visible in the buffer similar to goyo.vim)
- Code formatting / prettifying
- gitsigns for git diffs
2021-05-05 01:21:04 +00:00
2021-06-26 07:03:02 +00:00
# Requirements
2021-06-08 16:44:15 +00:00
- neovim 0.5
2021-06-26 07:03:02 +00:00
- A terminal that supports [nerdfonts](https://github.com/ryanoasis/nerd-fonts)
2021-06-08 16:44:15 +00:00
- Set terminal's inner padding to 0.
2021-06-08 16:23:11 +00:00
# Wiki
2021-03-13 11:03:42 +00:00
2021-06-19 14:54:28 +00:00
- [pre-requisite](https://github.com/siduck76/NvChad/wiki/Lua-guides)
2021-06-08 16:23:11 +00:00
- [config-structure](https://github.com/siduck76/NvChad/wiki#config-structure)
- [mappings](https://github.com/siduck76/NvChad/wiki/mappings)
2021-03-13 11:03:42 +00:00
2021-07-14 01:24:14 +00:00
# Bloat
2021-07-18 18:05:25 +00:00
- To all those who think this is probably bloated , sure it is . Bloat means different to everyone . NvChad has like 30 ~ plugins but that doesnt mean those plugins are compromsing neovim's speed, snappiness or making it slow. No matter how many plugins I'd add on nvchad , it wouldnt compromise speed / snappiness / make it slow or whatever since it uses packer.nvim as plugin manager , packer.nvim lets you lazy load plugins i.e loading plugins on certain events , mappings , sequentially loading them etc so loading them only when needed , I have lazy loaded all the plugins so most plugins arent loaded by default , hence not affecting neovim's startup/launch time.
2021-07-14 01:24:14 +00:00
<img src = "https://chadpaste.com/f/kdmxdabxbk.png">
# TODO
2021-06-15 18:09:40 +00:00
It would be nice if NvChad focuses on existing plugins and config before adding new things , some plugins like whichkey , telescope , treesitter still have basic configs! Also adding new features that'd make NvChad slow or its startuptime slow wouldnt be encouraged , if that feature's really needed then It'll be mentioned in the wiki with its config.
2021-08-04 03:09:43 +00:00
- Debloat the config.
- Make NvChad more faster (reduce startuptime too).
- Add another section in the wiki explaining the whole config (must be helpful for newbies).
2021-04-14 01:59:42 +00:00
- Add more themes.
2021-08-04 03:09:43 +00:00
- Preview shortcuts in the form of a pretty [cheatsheet](https://user-images.githubusercontent.com/59060246/122490009-95fd9980-cffe-11eb-9676-78019aa2cd65.png).
- Add a user config so it doesnt get hard to update :c
2021-06-26 07:03:02 +00:00
# Contribute
2021-06-26 07:03:02 +00:00
- PR's are always welcomed however NvChad aims to be less bloated and suckless. So PR's regarding existing plugin's enhancement , bug fixes are more encouraged.
2021-06-18 06:09:40 +00:00
- PR's regarding adding new plugins and their configs must be given some thought since NvChad aims to have a minimal config and meant to be used as a "base" neovim config so it will have only a set of important plugins. So adding more and more plugins, making NvChad bloated + slow wont help!.
2021-06-26 07:03:02 +00:00
- NvChad isnt a Framework. NvChad wont keep adding more and more features ( adding new plugins most likely) as requested , no spoonfeeding!! If you think the plugin you want to be added is very useful and many NvChaders would find it useful, then such feature's PR is welcomed!
2021-06-18 06:12:25 +00:00
- But adding specific features like adding config for https://github.com/wakatime/vim-wakatime etc will be added in this https://github.com/siduck76/NvChad/wiki/Chad-user-configs. This lets the user select the things only they want ( from extra configs ) .
2021-06-15 18:09:40 +00:00
2021-08-14 10:42:44 +00:00
# Chad contributors
<a href = "https://github.com/Tanu-N-Prabhu/Python/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=siduck76/NvChad"/>
</a>
2021-06-26 07:03:02 +00:00
## :gift_heart: Support
2021-06-15 18:09:40 +00:00
If you enjoy using NvChad and would like to show your appreciation, you may want to tip me here.
2021-06-15 18:22:11 +00:00
It is never required but always appreciated.
2021-06-15 18:09:40 +00:00
<p align="center">
<a href="https://www.buymeacoffee.com/siduck7" target="_blank"><img alt="undefined" width="48px" src="https://raw.githubusercontent.com/adi1090x/files/master/other/1.png"></a>
<a href="https://ko-fi.com/siduck76" target="_blank"><img alt="undefined" width="48px" src="https://raw.githubusercontent.com/adi1090x/files/master/other/2.png"></a>
<a href="https://www.paypal.com/paypalme/siduck76" target="_blank"><img alt="undefined" width="48px" src="https://raw.githubusercontent.com/adi1090x/files/master/other/3.png"></a>
</p>