nvchad/README.md
2021-06-26 12:33:02 +05:30

6.8 KiB

Super-Linter Gitter

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

Screenshots






Very Very Useful lua plugins used in my config

Lspkind-nvim

This tiny plugin adds vscode-like pictograms to neovim built-in lsp completion items :


Nvim-tree.lua

fast file tree :


Telescope-nvim

A fuzzy file finder, picker, sorter, previewer and much more:


Indent-blankline.nvim

adds indentline :

Galaxyline

fastest statusline plugin I've used so far:


Nvim-bufferline.lua

As a top tabline like thing which lets me handle tabs and buffers like switching , sorting and closing them etc.

Nvim-web-devicons

Lua fork of vim devicons which lets me change icons of filetypes

Nvim-treesitter

Better syntax highlighting for programming languages ( my config just has html,css,js support for now ).

without / with Treesitter :

Features

  • File navigation with Nvimtree
  • Using plugins that are mouse friendly
  • sexy themes
  • managing tabs , buffers 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
  • lspInstall for installing lsp servers easily.
  • 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
  • Set terminal's inner padding to 0.

Wiki

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.
  • Preview shortcuts in the form of a pretty cheatsheet
  • Add a global configuration so it doesnt get hard to update :c

Contribute

  • 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!
  • 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 ) .

💝 Support

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.

undefined undefined undefined