Add README for nvim config
This commit is contained in:
parent
ca62386d97
commit
73e9777a2b
119
dot_config/nvim/README.md
Normal file
119
dot_config/nvim/README.md
Normal file
@ -0,0 +1,119 @@
|
|||||||
|
# Neovim Setup
|
||||||
|
|
||||||
|
Autocompletion and "code intellisense" is provided by the LSP client built into
|
||||||
|
Neovim. The following language servers are configured:
|
||||||
|
|
||||||
|
* tsserver
|
||||||
|
* eslint
|
||||||
|
* cssls
|
||||||
|
* html
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
* Neovim v0.8 or greater.
|
||||||
|
* git.
|
||||||
|
* [make](https://www.gnu.org/software/make/), the build tool.
|
||||||
|
* [npm cli](https://docs.npmjs.com/cli/v8/commands/npm). Javascript package manager.
|
||||||
|
* [nodejs](https://nodejs.org/es/). Javascript runtime. Required by the language servers listed above.
|
||||||
|
* [ripgrep](https://github.com/BurntSushi/ripgrep). Improves project wide search speed.
|
||||||
|
* [fd](https://github.com/sharkdp/fd). Improves file search speed.
|
||||||
|
* A patched font to display icons. I hear [nerdfonts](https://www.nerdfonts.com/) has a good collection.
|
||||||
|
|
||||||
|
## Keybindings
|
||||||
|
|
||||||
|
Leader key: `Space`.
|
||||||
|
|
||||||
|
| Mode | Key | Action |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Normal | `<leader>h` | Go to first non empty character in line. |
|
||||||
|
| Normal | `<leader>l` | Go to last non empty character in line. |
|
||||||
|
| Normal | `<leader>a` | Select all text. |
|
||||||
|
| Normal | `cp` | Copy selected text to clipboard. |
|
||||||
|
| Normal | `cv` | Paste clipboard content. |
|
||||||
|
| Normal | `<leader>w` | Save file. |
|
||||||
|
| Normal | `<leader>bq` | Close current buffer. |
|
||||||
|
| Normal | `<leader>bc` | Close current buffer while preserving the window layout. |
|
||||||
|
| Normal | `<leader>bl` | Go to last active buffer. |
|
||||||
|
| Normal | `<leader>?` | Search oldfiles history. |
|
||||||
|
| Normal | `<leader><space>` | Search open buffers. |
|
||||||
|
| Normal | `<leader>ff` | Find file in current working directory. |
|
||||||
|
| Normal | `<leader>fg` | Search pattern in current working directory. Interactive "grep search". |
|
||||||
|
| Normal | `<leader>fd` | Search diagnostics in current file. |
|
||||||
|
| Normal | `<leader>fs` | Search pattern in current file. |
|
||||||
|
| Normal | `<leader>e` | Open file explorer. |
|
||||||
|
| Normal | `<Ctrl-g>` | Toggle the builtin terminal. |
|
||||||
|
| Normal | `K` | Displays hover information about the symbol under the cursor. |
|
||||||
|
| Normal | `gd` | Jump to the definition. |
|
||||||
|
| Normal | `gD` | Jump to declaration. |
|
||||||
|
| Normal | `gi` | Lists all the implementations for the symbol under the cursor. |
|
||||||
|
| Normal | `go` | Jumps to the definition of the type symbol |
|
||||||
|
| Normal | `gr` | Lists all the references. |
|
||||||
|
| Normal | `gs` | Displays a function's signature information. |
|
||||||
|
| Normal | `<F2>` | Renames all references to the symbol under the cursor. |
|
||||||
|
| Normal | `<F3>` | Format code in current buffer. |
|
||||||
|
| Normal | `<F4>` | Selects a code action available at the current cursor position. |
|
||||||
|
| Visual | `<F4>` | Selects a code action available in the selected text. |
|
||||||
|
| Normal | `gl` | Show diagnostics in a floating window. |
|
||||||
|
| Normal | `[d` | Move to the previous diagnostic. |
|
||||||
|
| Normal | `]d` | Move to the next diagnostic. |
|
||||||
|
|
||||||
|
### Autocomplete keybindings
|
||||||
|
|
||||||
|
| Mode | Key | Action |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Insert | `<Up>` | Move to previous item. |
|
||||||
|
| Insert | `<Down>` | Move to next item. |
|
||||||
|
| Insert | `<Ctrl-p>` | Move to previous item. |
|
||||||
|
| Insert | `<Ctrl-n>` | Move to next item. |
|
||||||
|
| Insert | `<Ctrl-u>` | Scroll up in documentation window. |
|
||||||
|
| Insert | `<Ctrl-d>` | Scroll down in documentation window. |
|
||||||
|
| Insert | `<Ctrl-e>` | Cancel completion. |
|
||||||
|
| Insert | `<C-y>` | Confirm completion. |
|
||||||
|
| Insert | `<Enter>` | Confirm completion. |
|
||||||
|
| Insert | `<Ctrl-f>` | Go to next placeholder in snippet. |
|
||||||
|
| Insert | `<Ctrl-b>` | Go to previous placeholder in snippet. |
|
||||||
|
| Insert | `<Tab>` | If completion menu is open, go to next item. Else, open completion menu. |
|
||||||
|
| Insert | `<Shift-Tab>` | If completion menu is open, go to previous item. |
|
||||||
|
|
||||||
|
## Plugin list
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| [paq-nvim](https://github.com/savq/paq-nvim) | Plugin manager. |
|
||||||
|
| [gruvbox.nvim](https://github.com/ellisonleao/gruvbox.nvim) | Gruvbox colorscheme for Neovim. |
|
||||||
|
| [nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons) | Helper functions to show icons. |
|
||||||
|
| [nvim-colorizer.lua](https://github.com/norcalli/nvim-colorizer.lua) | The fastest Neovim colorizer. |
|
||||||
|
| [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) | Pretty statusline. |
|
||||||
|
| [indent-blankline.nvim](https://github.com/lukas-reineke/indent-blankline.nvim) | Shows indent guides in current file. |
|
||||||
|
| [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) | Fuzzy finder. |
|
||||||
|
| [telescope-fzf-native.nvim](https://github.com/nvim-telescope/telescope-fzf-native.nvim) | Extension for telescope. Allows fzf-like syntax in searches. |
|
||||||
|
| [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) | Shows indicators in gutter based on file changes detected by git. |
|
||||||
|
| [vim-fugitive](https://github.com/tpope/vim-fugitive) | Git integration into Neovim/Vim. |
|
||||||
|
| [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) | Configures treesitter parsers. Provides modules to manipulate code. |
|
||||||
|
| [nvim-treesitter-textobjects](https://github.com/nvim-treesitter/nvim-treesitter-textobjects) | Creates textobjects based on treesitter queries. |
|
||||||
|
| [telescope-file-browser.nvim](https://github.com/nvim-telescope/telescope-file-browser.nvim) | File Browser extension for telescope.nvim. |
|
||||||
|
| [Comment.nvim](https://github.com/numToStr/Comment.nvim) | Toggle comments. |
|
||||||
|
| [nvim-surround](https://github.com/kylechui/nvim-surround) | Add/change/delete surrounding delimiter pairs with ease. |
|
||||||
|
| [nvim-autopairs](https://github.com/windwp/nvim-autopairs) | Autopairs for neovim. |
|
||||||
|
| [hop.nvim](https://github.com/phaazon/hop.nvim) | Neovim motions on speed! |
|
||||||
|
| [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) | Collection of modules. Used internaly by other plugins. |
|
||||||
|
| [toggleterm.nvim](https://github.com/akinsho/toggleterm.nvim) | Manage terminal windows easily. |
|
||||||
|
| [mason.nvim](https://github.com/williamboman/mason.nvim) | Portable package manager for Neovim. |
|
||||||
|
| [mason-lspconfig.nvim](https://github.com/williamboman/mason-lspconfig.nvim) | Integrates nvim-lspconfig and mason.nvim. |
|
||||||
|
| [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) | Quickstart configs for Neovim's LSP client. |
|
||||||
|
| [lspkind.nvim](https://github.com/onsails/lspkind.nvim) | vscode-like pictograms for neovim lsp completion items. |
|
||||||
|
| [lsp-format.nvim](https://github.com/lukas-reineke/lsp-format.nvim) | A wrapper around Neovims native LSP formatting. |
|
||||||
|
| [trouble.nvim](https://github.com/folke/trouble.nvim) | A pretty diagnostics, references, telescope results, quickfix and location list. |
|
||||||
|
| [nvim-dap](https://github.com/mfussenegger/nvim-dap) | Debug Adapter Protocol client implementation for Neovim |
|
||||||
|
| [nvim-dap-virtual-text](https://github.com/theHamsta/nvim-dap-virtual-text) | Virtual text support to nvim-dap |
|
||||||
|
| [nvim-dap-ui](https://github.com/rcarriga/nvim-dap-ui) | A UI for nvim-dap |
|
||||||
|
| [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) | Autocompletion engine. |
|
||||||
|
| [cmp-buffer](https://github.com/hrsh7th/cmp-buffer) | nvim-cmp source. Suggest words in the current buffer. |
|
||||||
|
| [cmp-path](https://github.com/hrsh7th/cmp-path) | nvim-cmp source. Show suggestions based on file system paths. |
|
||||||
|
| [cmp_luasnip](https://github.com/saadparwaiz1/cmp_luasnip) | nvim-cmp source. Show suggestions based on installed snippets. |
|
||||||
|
| [cmp-nvim-lsp](https://github.com/hrsh7th/cmp-nvim-lsp) | nvim-cmp source. Show suggestions based on LSP servers queries. |
|
||||||
|
| [cmp-nvim-lua](https://github.com/hrsh7th/cmp-nvim-lua) | nvim-cmp source for nvim lua. |
|
||||||
|
| [LuaSnip](https://github.com/L3MON4D3/LuaSnip) | Snippet engine. |
|
||||||
|
| [friendly-snippets](https://github.com/rafamadriz/friendly-snippets) | Collection of snippets. |
|
||||||
|
| [telekasten.nvim](https://github.com/renerocksai/telekasten.nvim) | A Neovim (lua) plugin for working with a markdown zettelkasten / wiki and mixing it with a journal |
|
||||||
|
| [calendar-vim](https://github.com/renerocksai/calendar-vim) | calendar in vimscript |
|
||||||
Loading…
Reference in New Issue
Block a user