Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add Plugins/Config #105

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: add Plugins/Config #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 75 additions & 5 deletions docs/plugins/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,79 @@ description: Learn how to use Yazi's Lua API.

# Config

TODO
## Builtin

- BOOT
- MANAGER
- THEME
- PREVIEW
### `archive`

Preview the hovered archive.

### `code`

<!-- TODO -->

### `dds`

Refer to [DDS#dds.lua](/docs/dds#dds.lua)

### `file`

Reveal type of the hovered file.

### `folder`

Preview the hovered folder.

### `font`

<!-- TODO -->

### `fzf`

<!-- TODO: doesn't work -->

### `image`

Preview the hovered image.

### `json`

Preview the hovered json using [jq](https://jqlang.github.io/jq/).

### `magick`

<!-- TODO -->

### `mime`

Determine and maintain mime types of files.

### `noop`

Do nothing.

### `pdf`

Preview the hovered PDF.

### `session`

Refer to [DDS#session.lua](/docs/dds#session.lua)

### `video`

Preview the hovered video.

### `zoxide`

Jump to a directory using zoxide.

Default config:

```lua
opts = {
---@type boolean
--- Subscribe `cd` event and add destination to
--- zoxide database everytime
update_db = false,
}
```