neovim-config/README.md

[![Super-Linter](https://github.com/siduck76/NvChad/actions/workflows/superLinter.yml/badge.svg)](https://github.com/siduck76/NvChad/actions/workflows/superLinter.yml)
[![Gitter](https://badges.gitter.im/neovim-dotfiles/community.svg)](https://gitter.im/neovim-dotfiles/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

An attempt to make neovim (cli version) as functional as an IDE while being very eyecandy.

# Screenshots -

<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/dashboard-nvim.png"><hr>
<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>
<kbd><img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimRice2.png"></kbd><hr>

# Very Useful lua plugins used in my config -

#### lspkind-nvim

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>

#### nvim-tree.lua

fast file tree :

<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png"></kbd><hr>

### 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>

### indent-blankline.nvim -

adds indentline :
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/blanklineNvim.png"></kbd>

### 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>

<hr>

### nvim-bufferline.lua -

As a top bufferline like thing which lets me handle tabs like switching, closing tabs.
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/bufferline.png"></kbd>

<hr>
 
### nvim-web-devicons -
Lua fork of vim devicons which lets me change icons of filetypes
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/image.png"></kbd><hr>
 
### nvim-treesitter 
Better syntax highlighting for programming languages ( my config just has html,css,js support for now ).

without / with Treesitter :
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/woTree.png"></kbd>

# Features

- File navigation with Nvimtree
- mouse works
- managing tabs with bufferline
- autosave
- icons on nvimtree , telescope , bufferline/statusline and almost everywhere! with nvim-web-devicons
- minimal status line ( galaxyline)
- gitsigns (colored bars for git in my config)
- using nvim-lsp
- nvim-lspconfig for nvim-lps configuration
- nvim-compe for autocompletion
- lspkind to show pictograms on autocompletion items
- telescope for file finding , picking , previewing (files and even images)
- nvim-treesitter for syntax highlighting
- nvim-autopairs , for autolosing braces and stuffs
- neoformat for prettifying / formatting code
- packer.nvim as package manager
- indent-blankline.Nvim for indentlines
- smooth scrolling
- Snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets)

# Requirements 

- neovim 0.5
- A terminal that supports [nerdfonts](https://github.com/ryanoasis/nerd-fonts) 
- Set terminal's inner padding to 0.

# Wiki

- [config-structure](https://github.com/siduck76/NvChad/wiki#config-structure)
- [Install](https://github.com/siduck76/NvChad/wiki#clone-my-setup)
- [mappings](https://github.com/siduck76/NvChad/wiki/mappings)

# TODO

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.

- Debloat the config
- Add more themes.
- Add a theme switcher.
- Add a global configuration so it doesnt get hard to update :c 

# Contact -

- My linux / unix related ricing community: https://t.me/DE_WM (telegram)
- Me: @siduck (telegram)

## :gift_heart:  Tip Jar

If you enjoy using NvChad and would like to show your appreciation, you may want to tip me here.

It is never required but always appreciated ^-^.

<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>
Update README.md 2021-06-02 05:46:17 +00:00			`[![Super-Linter](https://github.com/siduck76/NvChad/actions/workflows/superLinter.yml/badge.svg)](https://github.com/siduck76/NvChad/actions/workflows/superLinter.yml)`
update todo and some stuff 2021-06-15 18:09:40 +00:00			`[![Gitter](https://badges.gitter.im/neovim-dotfiles/community.svg)](https://gitter.im/neovim-dotfiles/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)`
added linter for push on main to double check the lua and shell languages. 2021-05-17 20:14:10 +00:00
Update README.md 2021-05-13 04:42:36 +00:00			`An attempt to make neovim (cli version) as functional as an IDE while being very eyecandy.`
screenshots 2021-03-08 08:14:21 +00:00
Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00			`# Screenshots -`
screenshots 2021-03-08 08:14:21 +00:00
add screenshot for dashboard-nvim 2021-06-14 06:34:12 +00:00			`<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/dashboard-nvim.png"><hr>`
Update README.md 2021-06-14 06:15:40 +00:00			`<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim1.png"><hr>`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim.png"><hr>`
			`<kbd><img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimRice2.png"></kbd><hr>`
plugin list info 2021-03-10 09:05:16 +00:00
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`# Very Useful lua plugins used in my config -`
Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00
			`#### lspkind-nvim`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00
minor changes 2021-03-15 10:55:25 +00:00			`This tiny plugin adds vscode-like pictograms to neovim built-in lsp completion items :`
Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/lspkind.png"></kbd><hr>`
Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`#### nvim-tree.lua`

			`fast file tree :`

			`<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png"></kbd><hr>`
telescope nvim screenshot 2021-03-13 08:04:10 +00:00
add blankline screenshot and clean readme 2021-03-26 05:02:04 +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>`

			`### indent-blankline.nvim -`

			`adds indentline :`
			`<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/blanklineNvim.png"></kbd>`
telescope nvim screenshot 2021-03-13 08:04:10 +00:00
Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00			`### galaxyline -`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00
			`fastest statusline plugin I've used so far:`
			`<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/statusline.png"></kbd><hr>`

Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00			`<hr>`
Update README.md 2021-03-13 02:18:06 +00:00
Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00			`### nvim-bufferline.lua -`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00
Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00			`As a top bufferline like thing which lets me handle tabs like switching, closing tabs.`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/bufferline.png"></kbd>`

Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00			`<hr>`
Update README.md 2021-03-13 02:18:06 +00:00
Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00			`### nvim-web-devicons -`
			`Lua fork of vim devicons which lets me change icons of filetypes`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/image.png"></kbd><hr>`
Update README.md 2021-03-13 02:18:06 +00:00
Update README.md This is how I would like it to be ;) Change things you don't like (like those `-` on headers) 2021-03-14 16:48:48 +00:00			`### nvim-treesitter`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`Better syntax highlighting for programming languages ( my config just has html,css,js support for now ).`
Update README.md 2021-03-13 03:05:22 +00:00
Update README.md 2021-04-29 15:25:03 +00:00			`without / with Treesitter :`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/woTree.png"></kbd>`

features 2021-03-19 12:34:18 +00:00			`# Features`

add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`- File navigation with Nvimtree`
features 2021-03-19 12:34:18 +00:00			`- mouse works`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`- managing tabs with bufferline`
features 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)`
Update README.md 2021-06-14 06:15:40 +00:00			`- gitsigns (colored bars for git in my config)`
features 2021-03-19 12:34:18 +00:00			`- using nvim-lsp`
			`- nvim-lspconfig for nvim-lps configuration`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`- nvim-compe for autocompletion`
features 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)`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`- nvim-treesitter for syntax highlighting`
			`- nvim-autopairs , for autolosing braces and stuffs`
			`- neoformat for prettifying / formatting code`
features 2021-03-19 12:34:18 +00:00			`- packer.nvim as package manager`
indentLine and blankline comparison 2021-03-31 01:23:59 +00:00			`- indent-blankline.Nvim for indentlines`
smooth scrolling 2021-03-31 02:00:33 +00:00			`- smooth scrolling`
Small change to the readme.md mentioning vsnip and what are snips are avail already. Changed one line in compe/lua.lua to indicate vsnip better. 2021-05-04 17:34:12 +00:00			`- Snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets)`
better config structure 2021-05-05 01:21:04 +00:00
Update README.md 2021-06-08 16:44:15 +00:00			`# Requirements`

			`- neovim 0.5`
			`- A terminal that supports [nerdfonts](https://github.com/ryanoasis/nerd-fonts)`
			`- Set terminal's inner padding to 0.`

move some stuff to wiki 2021-06-08 16:23:11 +00:00			`# Wiki`
Update README.md 2021-03-13 11:03:42 +00:00
move some stuff to wiki 2021-06-08 16:23:11 +00:00			`- [config-structure](https://github.com/siduck76/NvChad/wiki#config-structure)`
Update README.md 2021-06-08 16:41:59 +00:00			`- [Install](https://github.com/siduck76/NvChad/wiki#clone-my-setup)`
move some stuff to wiki 2021-06-08 16:23:11 +00:00			`- [mappings](https://github.com/siduck76/NvChad/wiki/mappings)`
Update README.md 2021-03-13 11:03:42 +00:00
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00			`# TODO`

update todo and some stuff 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.`

			`- Debloat the config`
Update README.md 2021-04-14 01:59:42 +00:00			`- Add more themes.`
update todo and some stuff 2021-06-15 18:09:40 +00:00			`- Add a theme switcher.`
			`- Add a global configuration so it doesnt get hard to update :c`
add blankline screenshot and clean readme 2021-03-26 05:02:04 +00:00
			`# Contact -`

			`- My linux / unix related ricing community: https://t.me/DE_WM (telegram)`
			`- Me: @siduck (telegram)`
update todo and some stuff 2021-06-15 18:09:40 +00:00
			`## :gift_heart: Tip Jar`

			`If you enjoy using NvChad and would like to show your appreciation, you may want to tip me here.`

			`It is never required but always appreciated ^-^.`

			`<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>`