From 0ac66cafbdf4b315c5fdb9e9c452c0afa82eab43 Mon Sep 17 00:00:00 2001 From: sxyazi Date: Tue, 10 Dec 2024 21:58:43 +0800 Subject: [PATCH] docs: add spotter keymap documentation --- docs/configuration/keymap.md | 39 ++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/docs/configuration/keymap.md b/docs/configuration/keymap.md index b37523e8..4e032724 100644 --- a/docs/configuration/keymap.md +++ b/docs/configuration/keymap.md @@ -13,6 +13,7 @@ You can change Yazi's keybindings in your `keymap.toml` file, which consists of - [\[manager\]](#manager) - File list. - [\[tasks\]](#tasks) - Task manager. +- [\[spot\]](#spot) - File information spotter. - [\[pick\]](#pick) - Pick component. e.g. "open with" for files. - [\[input\]](#input) - Input component. e.g. create, rename, etc. - [\[completion\]](#completion) - Completion component. e.g. "cd" path completion. @@ -524,6 +525,44 @@ See [Functional plugin](/docs/plugins/overview#functional-plugin). See [`noop` command](#manager.noop). +## [spot] {#spot} + +### `close` {#spot.close} + +Hide the spotter. + +### `arrow` {#spot.arrow} + +| Argument/Option | Description | +| --------------- | ------------------------------------------------------------------------------------- | +| `[n]` | Move the cursor up or down `n` lines. Negative value for up, positive value for down. | + +### `swipe` {#spot.swipe} + +| Argument/Option | Description | +| --------------- | -------------------------------------------------------------------------------------------- | +| `[n]` | Swipe `n` files up or down in the file list. Negative value for up, positive value for down. | + +### `copy` {#spot.copy} + +Copy the content from the spotter. + +| Argument/Option | Description | +| --------------- | ---------------------------- | +| `cell` | Copy the selected table cell | + +### `plugin` {#spot.plugin} + +See [Functional plugin](/docs/plugins/overview#functional-plugin). + +### `noop` {#spot.noop} + +See [`noop` command](#manager.noop). + +### `help` {#spot.help} + +Open the help menu. + ## [pick] {#pick} ### `close` {#pick.close}