nvchad/README.md

88 lines
3.9 KiB
Markdown
Raw Normal View History

2021-03-13 03:17:24 -05:00
The config is complete but still WIP as Im new to lua and slowly learning vim stuffs , so I'll keep adding new features like snippets etc and clean the config!
2021-03-13 02:50:11 -05:00
2021-03-12 22:10:15 -05:00
# Screenshots
2021-03-08 03:14:21 -05:00
2021-03-13 06:10:23 -05:00
<kbd> <img src ="https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/initialNvim.png"></kbd>
<kbd><img src ="https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/nvimRice2.png"></kbd>
2021-03-08 03:14:21 -05:00
2021-03-12 21:23:16 -05:00
# Some VERY COOL lua plugins I use
2021-03-10 04:05:16 -05:00
2021-03-12 21:23:16 -05:00
- nvim-lspkind , for showing lil icons/pictograms on completion items
2021-03-13 06:10:23 -05:00
<kbd><img src = "https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/lspkind.png"></kbd>
2021-03-12 21:18:06 -05:00
2021-03-10 04:05:59 -05:00
- nvim-tree.lua , a fast file tree
2021-03-13 06:10:23 -05:00
<kbd><img src = "https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/nvimtree.png"></kbd>
2021-03-12 21:18:06 -05:00
2021-03-13 03:04:10 -05:00
- telescope-nvim , a fuzzy file finder , picker , sorter , previewer and much more!
2021-03-13 06:10:23 -05:00
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/tel.png"></kbd>
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/telmedia.png"></kbd>
2021-03-13 03:04:10 -05:00
2021-03-12 21:14:02 -05:00
- galaxyline , a statusline plugin
2021-03-13 06:10:23 -05:00
<kbd><img src = "https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/statusline.png"></kbd>
2021-03-12 21:18:06 -05:00
2021-03-10 04:06:29 -05:00
- gitsigns.nvim , to show git signs of a repo on the signcolumn to indicate diffs/changes etc (needs plenary.nvim)
2021-03-12 21:18:06 -05:00
2021-03-12 21:23:16 -05:00
- nvim-bufferline.lua , as a top bufferline like thing which lets me handle tabs like switching , closing tabs.
2021-03-13 06:10:23 -05:00
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/bufferline.png"></kbd>
2021-03-12 21:18:06 -05:00
2021-03-12 21:14:02 -05:00
- nvim-web-devicons , lua fork of vim devicons which lets me change icons of filetypes
2021-03-13 06:10:23 -05:00
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/image.png"></kbd>
2021-03-12 21:18:06 -05:00
2021-03-13 03:19:42 -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-03-13 03:17:24 -05:00
without Treesitter
2021-03-13 06:10:23 -05:00
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/woTree.png"></kbd>
2021-03-13 03:17:24 -05:00
with Treesitter
2021-03-13 06:10:23 -05:00
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/wiTree.png"></kbd>
2021-03-13 03:17:24 -05:00
2021-03-13 06:02:13 -05:00
# Some guides to migrate to init.lua!
2021-03-13 06:03:42 -05:00
- https://github.com/nanotee/nvim-lua-guide
- https://alpha2phi.medium.com/neovim-init-lua-e80f4f136030
- https://oroques.dev/notes/neovim-init/
- https://icyphox.sh/blog/nvim-lua/
2021-03-13 03:17:24 -05:00
2021-03-12 22:10:15 -05:00
# Clone my setup
2021-03-12 22:05:22 -05:00
2021-03-12 22:06:52 -05:00
- Install neovim-nightly , also use a nerdfont on your terminal.
- Install packer.nvim
2021-03-13 08:07:38 -05:00
```shell
2021-03-12 22:07:27 -05:00
git clone https://github.com/wbthomason/packer.nvim\
~/.local/share/nvim/site/pack/packer/start/packer.nvim
2021-03-13 08:07:38 -05:00
```
2021-03-14 07:19:29 -04:00
2021-03-12 22:05:22 -05:00
2021-03-12 22:06:52 -05:00
- Open neovim and install all plugins , :PackerInstall and :TSUpdate
2021-03-13 03:18:50 -05:00
- Install language servers and prettier ( for autocompletion etc and code formatting , nodejs should be installed too!)
2021-03-14 07:19:29 -04:00
- copy all config files in from this repo except ( plugin folder )
2021-03-13 08:07:38 -05:00
```
sudo npm install -g vscode-html-languageserver-bin typescript typescript-language-server vscode-css-languageserver-bin prettier
```
2021-03-13 03:20:37 -05:00
2021-03-13 06:07:43 -05:00
To setup any language server , follow this guide https://github.com/neovim/nvim-lspconfig/blob/master/CONFIG.md and search up the needed LSP. For example if I needed clangd's lsp server :
<kbd>
2021-03-13 06:08:14 -05:00
<img src = "https://raw.githubusercontent.com/siduck76/personal-backup/master/rice%20flex/clang.png">
2021-03-13 06:07:43 -05:00
</kbd>
2021-03-13 05:43:44 -05:00
2021-03-13 06:10:23 -05:00
2021-03-13 05:43:44 -05:00
2021-03-13 22:48:57 -05:00
I'd install it first and add its setup line ( require'lspconfig'.clangd.setup{} ) in /lua/nvim-lspconfig/lua.lua file . I will organise the config slowly and soon add a list of important mappings used in my config , on this readme so it might get easy for some :)
2021-03-14 01:45:58 -05:00
# Troubleshooting
![image](https://user-images.githubusercontent.com/59060246/111059898-f096cf00-84be-11eb-977a-f91d622ee5b9.png)
if you get any errors with packer.nvim , then remove the ~/.config/nvim/plugin/packer_nvim.vim file since it just has file paths for my system
and re-install packer.nvim