From a6b553a958169faecb0c0cc2a3b18426548b7b01 Mon Sep 17 00:00:00 2001 From: TD-Sky Date: Sun, 21 Jul 2024 17:25:44 +0800 Subject: [PATCH] builtin plugins config: 1st ver --- docs/plugins/config.md | 80 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 75 insertions(+), 5 deletions(-) diff --git a/docs/plugins/config.md b/docs/plugins/config.md index 39c80e21..bca1a435 100644 --- a/docs/plugins/config.md +++ b/docs/plugins/config.md @@ -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` + + + +### `dds` + +Refer to [DDS#dds.lua](/docs/dds#dds.lua) + +### `file` + +Reveal type of the hovered file. + +### `folder` + +Preview the hovered folder. + +### `font` + + + +### `fzf` + + + +### `image` + +Preview the hovered image. + +### `json` + +Preview the hovered json using [jq](https://jqlang.github.io/jq/). + +### `magick` + + + +### `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, +} +```