neovim-config/README.md

129 lines
6.2 KiB
Markdown
Raw Normal View History

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)
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)
2021-06-18 06:09:40 +00:00
An attempt to make neovim (cli version) as functional as an IDE while being very eyecandy and less bloated.
2021-03-08 08:14:21 +00:00
# Screenshots -
2021-03-08 08:14:21 +00:00
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>
<img src ="https://cdn.discordapp.com/attachments/610012460828852229/853933487295299584/unknown.png"><hr>
2021-03-10 09:05:16 +00:00
# Very Useful lua plugins used in my config -
#### 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>
#### 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
### 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>
2021-03-13 08:04:10 +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>
<hr>
2021-03-13 02:18:06 +00:00
### 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>
2021-03-13 02:18:06 +00:00
### 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>
2021-03-13 02:18:06 +00:00
### 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-03-19 12:34:18 +00:00
# Features
- File navigation with Nvimtree
2021-03-19 12:34:18 +00:00
- mouse works
- managing tabs 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-03-19 12:34:18 +00:00
- using nvim-lsp
- nvim-lspconfig for nvim-lps configuration
- 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
- 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
- Snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets)
2021-05-05 01:21:04 +00:00
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.
2021-06-08 16:23:11 +00:00
# Wiki
2021-03-13 11:03:42 +00:00
2021-06-08 16:23:11 +00:00
- [config-structure](https://github.com/siduck76/NvChad/wiki#config-structure)
2021-06-08 16:41:59 +00:00
- [Install](https://github.com/siduck76/NvChad/wiki#clone-my-setup)
2021-06-08 16:23:11 +00:00
- [mappings](https://github.com/siduck76/NvChad/wiki/mappings)
2021-03-13 11:03:42 +00:00
# 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.
- Debloat the config
2021-04-14 01:59:42 +00:00
- Add more themes.
2021-06-15 18:09:40 +00:00
- Add a theme switcher.
- Add a global configuration so it doesnt get hard to update :c
2021-06-18 06:09:40 +00:00
# Contibute
2021-06-18 06:09:40 +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.
- 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!.
- 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-06-18 06:09:40 +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>
2021-06-18 06:09:40 +00:00
# Contact -
- My linux / unix related ricing community: https://t.me/DE_WM (telegram)
- Me: @siduck (telegram)