Skip to content

Commit

Permalink
docs: clarify that all configuration options are optional
Browse files Browse the repository at this point in the history
This hopefully addresses
#29
  • Loading branch information
mikavilpas committed Apr 16, 2024
1 parent cc91b3f commit 9a1f14c
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ First, make sure you have the requirements:
## ⚙️ Configuration

Using lazy.nvim:
Using [lazy.nvim](https://github.com/folke/lazy.nvim):

```lua
---@type LazySpec
Expand All @@ -40,13 +40,31 @@ Using lazy.nvim:
event = "VeryLazy",
keys = {
{
-- 👇 choose your own keymapping
"<leader>-",
function()
require("yazi").yazi()
end,
{ desc = "Open the file manager" },
},
},
---@type YaziConfig
opts = {
open_for_directories = false,
},
}
```

### Advanced configuration

> You don't have to set any of these options. The defaults are fine for most users.
You can optionally configure yazi.nvim by setting any of the options below.

```lua
{
-- ... other lazy.nvim configuration from above

---@type YaziConfig
opts = {
-- Below is the default configuration. It is optional to set these values.
Expand Down

0 comments on commit 9a1f14c

Please sign in to comment.