nvchad/README.md

121 lines
4.4 KiB
Markdown
Raw Normal View History

2021-06-02 01:46:17 -04:00
[![Super-Linter](https://github.com/siduck76/NvChad/actions/workflows/superLinter.yml/badge.svg)](https://github.com/siduck76/NvChad/actions/workflows/superLinter.yml)
2021-05-13 00:42:36 -04:00
An attempt to make neovim (cli version) as functional as an IDE while being very eyecandy.
2021-03-08 03:14:21 -05:00
# Screenshots -
2021-03-08 03:14:21 -05: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>
2021-03-10 04:05:16 -05:00
# Very Useful lua plugins used in my config -
#### lspkind-nvim
2021-03-15 06:55:25 -04: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 03:04:10 -05: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 03:04:10 -05:00
2021-03-30 21:23:59 -04:00
using indenLine plugin on left and blanklineNvim on right
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/blanklineVSindentline.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>
### gitsigns.nvim -
Shows git signs of a repo on the signcolumn to indicate diffs/changes etc (needs plenary.nvim)
<hr>
2021-03-12 21:18:06 -05: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-12 21:18:06 -05: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-12 21:18:06 -05:00
### nvim-treesitter
Better syntax highlighting for programming languages ( my config just has html,css,js support for now ).
2021-03-12 22:05:22 -05:00
2021-04-29 11:25:03 -04:00
without / with Treesitter :
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/woTree.png"></kbd>
### nvim-base16 -
contains a collection of all base16 themes for vim , plugin written in lua (comparison of base16-vim and nvim-base16):
nvim-base16 doesnt even take time to load unlike base16-vim which was eating half of the loadup time! ( the below screenshot was taken and tested on my old pentium laptop , so results might differ)
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvim-base16.png"></kbd><hr>
(neovim loads pretty fast on ssds)
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvim-startup.png"></kbd><hr>
2021-03-19 08:34:18 -04:00
# Features
- File navigation with Nvimtree
2021-03-19 08:34:18 -04:00
- mouse works
- managing tabs with bufferline
2021-03-19 08:34:18 -04:00
- autosave
- icons on nvimtree , telescope , bufferline/statusline and almost everywhere! with nvim-web-devicons
- minimal status line ( galaxyline)
- gitsigns (colored bars in my config)
- using nvim-lsp
- nvim-lspconfig for nvim-lps configuration
- nvim-compe for autocompletion
2021-03-19 08:34:18 -04: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 08:34:18 -04:00
- packer.nvim as package manager
2021-03-30 21:23:59 -04:00
- indent-blankline.Nvim for indentlines
2021-03-30 22:00:33 -04:00
- smooth scrolling
- Snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets)
2021-05-04 21:21:04 -04:00
2021-06-08 12:44:15 -04: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 12:23:11 -04:00
# Wiki
2021-03-13 06:03:42 -05:00
2021-06-08 12:23:11 -04:00
- [config-structure](https://github.com/siduck76/NvChad/wiki#config-structure)
2021-06-08 12:41:59 -04:00
- [Install](https://github.com/siduck76/NvChad/wiki#clone-my-setup)
2021-06-08 12:23:11 -04:00
- [mappings](https://github.com/siduck76/NvChad/wiki/mappings)
2021-03-13 06:03:42 -05:00
# TODO
2021-04-13 21:59:42 -04:00
- Add more themes.
2021-06-08 12:23:11 -04:00
- Add a theme switcher
# Contact -
- My linux / unix related ricing community: https://t.me/DE_WM (telegram)
- Me: @siduck (telegram)