mirror of
				https://github.com/NotAShelf/nvf.git
				synced 2025-10-31 11:02:37 +00:00 
			
		
		
		
	Docs/map rewrite (#403)
* doc: fix formatting * docs: update keymaps section
This commit is contained in:
		
					parent
					
						
							
								7a8b95cf7c
							
						
					
				
			
			
				commit
				
					
						b39b84490f
					
				
			
		
					 2 changed files with 10 additions and 21 deletions
				
			
		|  | @ -7,37 +7,26 @@ section contains a general overview to how you may utilize said functions. | ||||||
| 
 | 
 | ||||||
| ## Custom Key Mappings Support for a Plugin {#sec-custom-key-mappings} | ## Custom Key Mappings Support for a Plugin {#sec-custom-key-mappings} | ||||||
| 
 | 
 | ||||||
| To set a mapping, you should define it in `vim.maps.<<mode>>`. | To set a mapping, you should define it in `vim.keymaps`. | ||||||
| The available modes are: |  | ||||||
| 
 |  | ||||||
| - normal |  | ||||||
| - insert |  | ||||||
| - select |  | ||||||
| - visual |  | ||||||
| - terminal |  | ||||||
| - normalVisualOp |  | ||||||
| - visualOnly |  | ||||||
| - operator |  | ||||||
| - insertCommand |  | ||||||
| - lang |  | ||||||
| - command |  | ||||||
| 
 | 
 | ||||||
| An example, simple keybinding, can look like this: | An example, simple keybinding, can look like this: | ||||||
| 
 | 
 | ||||||
| ```nix | ```nix | ||||||
| { | { | ||||||
|   vim.maps.normal = { |   vim.keymaps = [ | ||||||
|     "<leader>wq" = { |     { | ||||||
|  |       key = "<leader>wq"; | ||||||
|  |       mode = ["n"]; | ||||||
|       action = ":wq<CR>"; |       action = ":wq<CR>"; | ||||||
|       silent = true; |       silent = true; | ||||||
|       desc = "Save file and quit"; |       desc = "Save file and quit"; | ||||||
|     }; |     } | ||||||
|   }; |   ]; | ||||||
| } | } | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| There are many settings available in the options. Please refer to the | There are many settings available in the options. Please refer to the | ||||||
| [documentation](https://notashelf.github.io/nvf/options.html#opt-vim.maps.command._name_.action) | [documentation](https://notashelf.github.io/nvf/options.html#opt-vim.keymaps) | ||||||
| to see a list of them. | to see a list of them. | ||||||
| 
 | 
 | ||||||
| **nvf** provides a list of helper commands, so that you don't have to write the | **nvf** provides a list of helper commands, so that you don't have to write the | ||||||
|  |  | ||||||
|  | @ -1,5 +1,5 @@ | ||||||
| {lib, ...}: let | {lib, ...}: let | ||||||
|   inherit (lib.options) mkOption; |   inherit (lib.options) mkOption literalMD; | ||||||
|   inherit (lib.types) either str listOf attrsOf nullOr submodule; |   inherit (lib.types) either str listOf attrsOf nullOr submodule; | ||||||
|   inherit (lib.nvim.config) mkBool; |   inherit (lib.nvim.config) mkBool; | ||||||
| 
 | 
 | ||||||
|  | @ -42,7 +42,7 @@ | ||||||
| 
 | 
 | ||||||
|             See `:help map-modes` for a list of modes. |             See `:help map-modes` for a list of modes. | ||||||
|           ''; |           ''; | ||||||
|           example = ''`["n" "v" "c"]` for normal, visual and command mode''; |           example = literalMD ''`["n" "v" "c"]` for normal, visual and command mode''; | ||||||
|         }; |         }; | ||||||
|       }; |       }; | ||||||
|   }; |   }; | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Ching Pei Yang
				Ching Pei Yang