From ba09b990a3b5aa3066ec47ba6653f03ad5b359b3 Mon Sep 17 00:00:00 2001 From: siduck76 Date: Tue, 8 Jun 2021 21:53:11 +0530 Subject: [PATCH] move some stuff to wiki --- README.md | 115 +++--------------------------------------------------- 1 file changed, 5 insertions(+), 110 deletions(-) diff --git a/README.md b/README.md index 26da8f4..e42dbd5 100644 --- a/README.md +++ b/README.md @@ -111,121 +111,16 @@ nvim-base16 doesnt even take time to load unlike base16-vim which was eating hal - smooth scrolling - Snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets) -# Guides to migrate your nvim configs to init.lua - +# Wiki -- https://github.com/nanotee/nvim-lua-guide +- [config-structure](https://github.com/siduck76/NvChad/wiki#config-structure) +- [Install](https://github.com/siduck76/NvChad/wiki#config-structure) +- [mappings](https://github.com/siduck76/NvChad/wiki/mappings) -- https://alpha2phi.medium.com/neovim-init-lua-e80f4f136030 - -- https://oroques.dev/notes/neovim-init/ - -- https://icyphox.sh/blog/nvim-lua/ - -- https://github.com/rafamadriz/friendly-snippets/wiki - -# Clone my setup - - -- Install neovim-nightly , also use a nerdfont on your terminal. -- Use these [colors](https://github.com/siduck76/dotfiles/blob/master/thinkpad/.Xresources) for your terminal , Its in xresources format so it'd would be easier to use a terminal that supports xresources like st , urxvt , xterm , My [st build](https://github.com/siduck76/st). -- run the install.sh (this might work only on nix systems),this opens neovim (press enter or y to skip the errors , the errors will only show once). -- Install ripgrep , fd , ueberzug for telescope media extension to work. - -- Manual installation , incase the install.sh doesnt work for you : - -- Install packer.nvim - -``` - -git clone https://github.com/wbthomason/packer.nvim\ - ~/.local/share/nvim/site/pack/packer/start/packer.nvim - -``` - -- copy lua folder and init.lua into ~/.config/nvim -- Open neovim and install all plugins , :PackerInstall (let treesitter install all its extensionsm -- Install language servers and prettier ( for autocompletion etc and code formatting , nodejs should be installed too!) , this usually depends on the language support you want to add in your neovim config. - -``` - install the languages you want , check [lspInstal-repo](https://github.com/kabouzeid/nvim-lspinstall) - - example - :LspInstall html -``` - -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 : - - - - - -I'd install it first and add its setup line : -`` -- in /lua/nvim-lspconfig/lua.lua file - - require'lspconfig'.clangd.setup{} `` - -# Default Mappings - - space is the **leader** key. - -- Opening terminals! -- Ctrl l Open terminal vertically over right -- Ctrl x Open terminal horizontally below the current window - -- **File tree (nvim-tree)** - -- Ctrl n toggle neovim tree - -- Shift h show hidden files (use these keybinds when cursor's in the filetree, same for the keybinds below). -- Ctrl + v open files in vertical split -- Ctrl + x open files in horizontal split - -- **Toggling stuffs** - -- leader + n toggle line number -- leader + z toggle truezen.nvim's Ataraxis mode -- leader + m toggle truezen.nvim's minimalistic mode - -- **Copy text** - -- Ctrl a copies everything in the current file -- select any text + y copies the selected text - -- **Telescope** - -- leader + f b open all buffers -- leader + f f find files in the current DIR -- leader + f o open recently edited files -- leader + f h opens up a help page like thing -- Ctrl + v open files in vertical split -- Ctrl + x open files in horizontal split - -- **Formatting code** - -- leader + f m formats or beautifies the code in current window via neoformat - (currently only html ,css , js can be formatted . To be able to use this keybind you need to install the formatter locally for your language , in my case prettier was required only so I installed it. check [this](https://github.com/sbdchd/neoformat). - -- **Neoscroll** - -- ``, ``, ``, ``, `` and `` : Smooth scrolling for window movement commands. - -- **Managing tabs with bufferline!** - -- TAB or Shift TAB cycle through opened tabs -- Shift x close current tab -- Shift t open new tab - -**Nvim-lspconfig (major ones)** -- K hover and show the definition -- gd jumps to the definition (works for user and language definitions) -- [d jumps to the previous error -- ]d jumps to the next error -- leader D jumps to the definition -- leader w + q list all the errors in a new buffer -- leader r + n rename all instances of this definition (user functions and declaration) -- # TODO -- Make the statusline more elegant. - Add more themes. +- Add a theme switcher # Contact -