Skip to content

Commit

Permalink
docs: improve yazi configuration documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Sep 16, 2024
1 parent 4a55cc5 commit 201e56c
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions docs/configuration/yazi.md
Original file line number Diff line number Diff line change
Expand Up @@ -418,35 +418,41 @@ As for the offset, it's a 4-element tuple: `(x, y, width, height)`.

Some inputs have special placeholders that will be replaced with actual content on display:

- trash_title: String
- cd_title: String

- `{n}`: Number of files to be trashed
- `{s}`: `"s"` if `n > 1`, otherwise `""`
Title of the [`cd --interactive`](/docs/configuration/keymap/#manager.cd) input used to enter the target path.

- delete_title: String
- create_title: [String, String]

- `{n}`: Number of files to be deleted
- `{s}`: `"s"` if `n > 1`, otherwise `""`
It's a tuple of 2-element: first for [`create`](/docs/configuration/keymap/#manager.create) input title, second for `create --dir` command.

- rename_title: String

Title of the [`rename`](/docs/configuration/keymap/#manager.rename) input used to enter the new name.

- filter_title: String

Title of the [`filter`](/docs/configuration/keymap/#manager.filter) input used to enter the keyword.

- find_title: [String, String]

It's a tuple of 2-element: first for "Find next", second for "Find previous".
It's a tuple of 2-element: first for [`find`](/docs/configuration/keymap/#manager.find), second for `find --previous`.

- search_title: String

- `{n}`: Name of the current search engine
- `{n}`: Name of the current [`search`](/docs/configuration/keymap/#manager.search) engine.

- shell_title: [String, String]

It's a tuple of 2-element: first for "Non-blocking shell", second for "Blocking shell".
It's a tuple of 2-element: first for [`shell --interactive`](/docs/configuration/keymap/#manager.shell), second for `shell --interactive --block`.

## [confirm] {#confirm}

- quit_title: String
- `{n}`: Number of tasks are running
- `{s}`: `"s"` if `n > 1`, otherwise `""`
TODO

## [select] {#select}

As same as the [`[input]`](#input) section.
Same as the [`[input]`](#input) section.

## [which] {#which}

Expand Down

0 comments on commit 201e56c

Please sign in to comment.