docs: add spot to the keymap and quick-start docs

yazi-rs · Dec 10, 2024 · 463414a · 463414a
1 parent b5886b6
commit 463414a
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 15 deletions.
diff --git a/docs/configuration/keymap.md b/docs/configuration/keymap.md
@@ -140,7 +140,9 @@ Scroll the contents in the preview panel.
 | --------------- | ---------------------------------------------------------------- |
 | `[n]`           | Use negative values to seek up and positive values to seek down. |
 
-Note that the default scroll keys are <kbd>Alt</kbd> + <kbd>j</kbd> and <kbd>Alt</kbd> + <kbd>k</kbd>, make sure your terminal supports <kbd>Alt</kbd> key combinations, or you can change them in your `keymap.toml`.
+### `spot` {#manager.spot}
+
+Display file information with the preset or user-customized spotter.
 
 ### `cd` {#manager.cd}
 

diff --git a/docs/configuration/yazi.md b/docs/configuration/yazi.md
@@ -293,7 +293,7 @@ Available rule options are as follows:
 
 With that:
 
-- If you're using the default mime-type preloader, it retrieves the mime-type of a file through `file -bL --mime-type /path/to/file` command.
+- You can [`spot`](/docs/configuration/keymap#manager.spot) on a file to check it's mime-type with the default <kbd>Tab</kbd> key.
 - If `use` is an array containing multiple openers, all commands in these openers will be merged. [`open`](/docs/configuration/keymap#manager.open) will run the first of these commands; [`open --interactive`](/docs/configuration/keymap#manager.open) will list all of these commands in the "open with" menu.
 
 ## [tasks] {#tasks}

diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -126,12 +126,14 @@ or Vim-like keys such as <kbd>h</kbd>, <kbd>j</kbd>, <kbd>k</kbd>, <kbd>l</kbd>:
 
 Further navigation commands can be found in the table below.
 
-| Key binding                 | Action                           |
-| --------------------------- | -------------------------------- |
-| <kbd>K</kbd>                | Seek up 5 units in the preview   |
-| <kbd>J</kbd>                | Seek down 5 units in the preview |
-| <kbd>g</kbd> ⇒ <kbd>g</kbd> | Move cursor to the top           |
-| <kbd>G</kbd>                | Move cursor to the bottom        |
+| Key binding                 | Action                                         |
+| --------------------------- | ---------------------------------------------- |
+| <kbd>K</kbd>                | Seek up 5 units in the preview                 |
+| <kbd>J</kbd>                | Seek down 5 units in the preview               |
+| <kbd>g</kbd> ⇒ <kbd>g</kbd> | Move cursor to the top                         |
+| <kbd>G</kbd>                | Move cursor to the bottom                      |
+| <kbd>z</kbd>                | Jump to a directory using zoxide               |
+| <kbd>Z</kbd>                | Jump to a directory or reveal a file using fzf |
 
 ### Selection
 
@@ -156,6 +158,7 @@ To interact with selected files/directories use any of the commands below.
 | <kbd>O</kbd>                        | Open selected files interactively                                       |
 | <kbd>Enter</kbd>                    | Open selected files                                                     |
 | <kbd>Shift</kbd> + <kbd>Enter</kbd> | Open selected files interactively (some terminals don't support it yet) |
+| <kbd>Tab</kbd>                      | Show the file information                                               |
 | <kbd>y</kbd>                        | Yank selected files (copy)                                              |
 | <kbd>x</kbd>                        | Yank selected files (cut)                                               |
 | <kbd>p</kbd>                        | Paste yanked files                                                      |
@@ -165,14 +168,17 @@ To interact with selected files/directories use any of the commands below.
 | <kbd>D</kbd>                        | Permanently delete selected files                                       |
 | <kbd>a</kbd>                        | Create a file (ends with / for directories)                             |
 | <kbd>r</kbd>                        | Rename selected file(s)                                                 |
-| <kbd>;</kbd>                        | Run a shell command                                                     |
-| <kbd>:</kbd>                        | Run a shell command (block until finishes)                              |
 | <kbd>.</kbd>                        | Toggle the visibility of hidden files                                   |
-| <kbd>-</kbd>                        | Symlink the absolute path of yanked files                               |
-| <kbd>\_</kbd>                       | Symlink the relative path of yanked files                               |
-| <kbd>Ctrl</kbd> + <kbd>-</kbd>      | Hardlink yanked files                                                   |
-| <kbd>z</kbd>                        | Jump to a directory using zoxide                                        |
-| <kbd>Z</kbd>                        | Jump to a directory or reveal a file using fzf                          |
+
+Further file operation commands can be found in the table below.
+
+| Key binding                    | Action                                     |
+| ------------------------------ | ------------------------------------------ |
+| <kbd>;</kbd>                   | Run a shell command                        |
+| <kbd>:</kbd>                   | Run a shell command (block until finishes) |
+| <kbd>-</kbd>                   | Symlink the absolute path of yanked files  |
+| <kbd>\_</kbd>                  | Symlink the relative path of yanked files  |
+| <kbd>Ctrl</kbd> + <kbd>-</kbd> | Hardlink yanked files                      |
 
 ### Copy paths