docs: Update Lazy install instructions (#129)

This commit is contained in:
Mainak Mandal
2024-10-01 13:45:16 +02:00
committed by GitHub
parent bd36b40814
commit 56760339a8

View File

@@ -33,23 +33,24 @@ Install using [`lazy.nvim`](https://github.com/folke/lazy.nvim):
```lua ```lua
-- nvim v0.8.0 -- nvim v0.8.0
return { return {
"kdheepak/lazygit.nvim", "kdheepak/lazygit.nvim",
cmd = { lazy = true,
"LazyGit", cmd = {
"LazyGitConfig", "LazyGit",
"LazyGitCurrentFile", "LazyGitConfig",
"LazyGitFilter", "LazyGitCurrentFile",
"LazyGitFilterCurrentFile", "LazyGitFilter",
}, "LazyGitFilterCurrentFile",
-- optional for floating window border decoration },
dependencies = { -- optional for floating window border decoration
"nvim-lua/plenary.nvim", dependencies = {
}, "nvim-lua/plenary.nvim",
-- setting the keybinding for LazyGit with 'keys' is recommended in },
-- order to load the plugin when the command is run for the first time -- setting the keybinding for LazyGit with 'keys' is recommended in
keys = { -- order to load the plugin when the command is run for the first time
{ "<leader>lg", "<cmd>LazyGit<cr>", desc = "LazyGit" } keys = {
} { "<leader>lg", "<cmd>LazyGit<cr>", desc = "LazyGit" }
}
} }
``` ```
@@ -226,18 +227,25 @@ Install using [`lazy.nvim`](https://github.com/folke/lazy.nvim):
```lua ```lua
-- nvim v0.8.0 -- nvim v0.8.0
require("lazy").setup({ {
{ "kdheepak/lazygit.nvim",
"kdheepak/lazygit.nvim", lazy = false,
dependencies = { cmd = {
"nvim-telescope/telescope.nvim", "LazyGit",
"nvim-lua/plenary.nvim" "LazyGitConfig",
}, "LazyGitCurrentFile",
config = function() "LazyGitFilter",
require("telescope").load_extension("lazygit") "LazyGitFilterCurrentFile",
end,
}, },
}) -- optional for floating window border decoration
dependencies = {
"nvim-telescope/telescope.nvim",
"nvim-lua/plenary.nvim",
},
config = function()
require("telescope").load_extension("lazygit")
end,
}
``` ```
Lazy loading `lazygit.nvim` for telescope functionality is not supported. Open an issue if you wish to have this feature. Lazy loading `lazygit.nvim` for telescope functionality is not supported. Open an issue if you wish to have this feature.