Move plugin examples from README to optional plugin files (#831)
* Move autopairs example from README to an optional plugin * Move neo-tree example from README to an optional plugin
This commit is contained in:
		
							parent
							
								
									5540527fab
								
							
						
					
					
						commit
						5e258d276f
					
				
							
								
								
									
										65
									
								
								README.md
								
								
								
								
							
							
						
						
									
										65
									
								
								README.md
								
								
								
								
							|  | @ -99,71 +99,10 @@ That's it! Lazy will install all the plugins you have. Use `:Lazy` to view | |||
| current plugin status. Hit `q` to close the window. | ||||
| 
 | ||||
| Read through the `init.lua` file in your configuration folder for more | ||||
| information about extending and exploring Neovim. | ||||
| information about extending and exploring Neovim. That includes also | ||||
| examples of adding popularly requested plugins. | ||||
| 
 | ||||
| 
 | ||||
| #### Examples of adding popularly requested plugins | ||||
| 
 | ||||
| NOTE: You'll need to uncomment the line in the init.lua that turns on loading custom plugins. | ||||
| 
 | ||||
| <details> | ||||
|   <summary>Adding autopairs</summary> | ||||
| 
 | ||||
| This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) | ||||
| and enable it on startup. For more information, see documentation for | ||||
| [lazy.nvim](https://github.com/folke/lazy.nvim). | ||||
| 
 | ||||
| In the file: `lua/custom/plugins/autopairs.lua`, add: | ||||
| 
 | ||||
| ```lua | ||||
| -- File: lua/custom/plugins/autopairs.lua | ||||
| 
 | ||||
| return { | ||||
|   "windwp/nvim-autopairs", | ||||
|   -- Optional dependency | ||||
|   dependencies = { 'hrsh7th/nvim-cmp' }, | ||||
|   config = function() | ||||
|     require("nvim-autopairs").setup {} | ||||
|     -- If you want to automatically add `(` after selecting a function or method | ||||
|     local cmp_autopairs = require('nvim-autopairs.completion.cmp') | ||||
|     local cmp = require('cmp') | ||||
|     cmp.event:on( | ||||
|       'confirm_done', | ||||
|       cmp_autopairs.on_confirm_done() | ||||
|     ) | ||||
|   end, | ||||
| } | ||||
| ``` | ||||
| 
 | ||||
| </details> | ||||
| <details> | ||||
|   <summary>Adding a file tree plugin</summary> | ||||
| 
 | ||||
| This will install the tree plugin and add the command `:Neotree` for you. | ||||
| For more information, see the documentation at | ||||
| [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim). | ||||
| 
 | ||||
| In the file: `lua/custom/plugins/filetree.lua`, add: | ||||
| 
 | ||||
| ```lua | ||||
| -- File: lua/custom/plugins/filetree.lua | ||||
| 
 | ||||
| return { | ||||
|   "nvim-neo-tree/neo-tree.nvim", | ||||
|   version = "*", | ||||
|   dependencies = { | ||||
|     "nvim-lua/plenary.nvim", | ||||
|     "nvim-tree/nvim-web-devicons", -- not strictly required, but recommended | ||||
|     "MunifTanjim/nui.nvim", | ||||
|   }, | ||||
|   config = function () | ||||
|     require('neo-tree').setup {} | ||||
|   end, | ||||
| } | ||||
| ``` | ||||
| 
 | ||||
| </details> | ||||
| 
 | ||||
| ### Getting Started | ||||
| 
 | ||||
| [The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o) | ||||
|  |  | |||
							
								
								
									
										2
									
								
								init.lua
								
								
								
								
							
							
						
						
									
										2
									
								
								init.lua
								
								
								
								
							|  | @ -854,6 +854,8 @@ require('lazy').setup({ | |||
|   -- require 'kickstart.plugins.debug', | ||||
|   -- require 'kickstart.plugins.indent_line', | ||||
|   -- require 'kickstart.plugins.lint', | ||||
|   -- require 'kickstart.plugins.autopairs', | ||||
|   -- require 'kickstart.plugins.neo-tree', | ||||
| 
 | ||||
|   -- NOTE: The import below can automatically add your own plugins, configuration, etc from `lua/custom/plugins/*.lua` | ||||
|   --    This is the easiest way to modularize your config. | ||||
|  |  | |||
|  | @ -0,0 +1,16 @@ | |||
| -- autopairs | ||||
| -- https://github.com/windwp/nvim-autopairs | ||||
| 
 | ||||
| return { | ||||
|   'windwp/nvim-autopairs', | ||||
|   event = 'InsertEnter', | ||||
|   -- Optional dependency | ||||
|   dependencies = { 'hrsh7th/nvim-cmp' }, | ||||
|   config = function() | ||||
|     require('nvim-autopairs').setup {} | ||||
|     -- If you want to automatically add `(` after selecting a function or method | ||||
|     local cmp_autopairs = require 'nvim-autopairs.completion.cmp' | ||||
|     local cmp = require 'cmp' | ||||
|     cmp.event:on('confirm_done', cmp_autopairs.on_confirm_done()) | ||||
|   end, | ||||
| } | ||||
|  | @ -0,0 +1,25 @@ | |||
| -- Neo-tree is a Neovim plugin to browse the file system | ||||
| -- https://github.com/nvim-neo-tree/neo-tree.nvim | ||||
| 
 | ||||
| return { | ||||
|   'nvim-neo-tree/neo-tree.nvim', | ||||
|   version = '*', | ||||
|   dependencies = { | ||||
|     'nvim-lua/plenary.nvim', | ||||
|     'nvim-tree/nvim-web-devicons', -- not strictly required, but recommended | ||||
|     'MunifTanjim/nui.nvim', | ||||
|   }, | ||||
|   cmd = 'Neotree', | ||||
|   keys = { | ||||
|     { '\\', ':Neotree reveal<CR>', { desc = 'NeoTree reveal' } }, | ||||
|   }, | ||||
|   opts = { | ||||
|     filesystem = { | ||||
|       window = { | ||||
|         mappings = { | ||||
|           ['\\'] = 'close_window', | ||||
|         }, | ||||
|       }, | ||||
|     }, | ||||
|   }, | ||||
| } | ||||
		Loading…
	
		Reference in New Issue
	
	 Damjan 9000
						Damjan 9000