diff options
author | Damjan 9000 <damjan.9000@gmail.com> | 2024-04-17 21:25:54 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-04-17 15:25:54 -0400 |
commit | 5e258d276fef52cc45a17021dc83a95748a0bc7f (patch) | |
tree | 28f7e5d6922f1eb68f8d19bf8164e6cd3e105137 /README.md | |
parent | 5540527fabc2776cf62b63ef511079b1c8bf5297 (diff) |
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
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 65 |
1 files changed, 2 insertions, 63 deletions
@@ -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) |