Skip to content

Commit

Permalink
docs: mention extra dependencies in README (#313)
Browse files Browse the repository at this point in the history
Closes #306
  • Loading branch information
mikavilpas authored Aug 3, 2024
1 parent c2e0686 commit 03c5bbe
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,14 @@ This is the preferred installation method.
}
```

Notice that yazi.nvim adds some minimal dependencies for you automatically when
using a plugin manager like lazy.nvim. To see which dependencies are installed,
see [lazy.lua](./lazy.lua). If you are not using lazy.nvim (or
[rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim?tab=readme-ov-file)),
you need to install the dependencies yourself. Also see the discussion in
[issue 306](https://github.com/mikavilpas/yazi.nvim/issues/306) and examples of
[other Neovim plugins using this feature](https://github.com/search?q=path%3A%2F%5Elazy%5C.lua%24%2F&type=code).

### Without a package manager

<details>
Expand Down
12 changes: 12 additions & 0 deletions lazy.lua
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
-- This file is used to define the dependencies of this plugin when the user is
-- using lazy.nvim.
--
-- If you are curious about how exactly the plugins are used, you can use e.g.
-- the search functionality on Github.
--
--https://lazy.folke.io/packages#lazy

---@module "lazy"
---@module "yazi"

---@type LazySpec
return {
-- Needed for file path resolution mainly
--
-- https://github.com/nvim-lua/plenary.nvim/
{ 'nvim-lua/plenary.nvim', lazy = true },

-- Needed to calculate a good buffer background color that fits the current
-- theme when yazi hovers over a file in an open window/split. The plugin
-- itself is never actually loaded, only some utilities that it comes with.
--
-- https://github.com/akinsho/bufferline.nvim
{ 'akinsho/bufferline.nvim', lazy = true },

--
Expand Down

0 comments on commit 03c5bbe

Please sign in to comment.