Skip to content

Commit

Permalink
docs: fix the type link in plugins overview
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Apr 24, 2024
1 parent 89f949c commit 537d18e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions docs/configuration/yazi.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,9 +165,9 @@ Available options are as follows:
- `$@` (Unix) / `%*` (Windows): All selected files, i.e. `$1`, `$2`, ..., `$n`.
- `$0` (Unix) / `%0` (Windows): The hovered file.
- `block`: Open in a blocking manner. After setting this, Yazi will hide into a secondary screen and display the program on the main screen until it exits. During this time, it can receive I/O signals, which is useful for interactive programs.
- `orphan`: Keep the process running even if Yazi has exited.
- `desc`: Description of the opener, displayed in the selection menu.
- `for`: Optional. This opener is only available on this system; when not specified, it's available on all systems. Available values:
- `orphan`: Keep the process running even if Yazi has exited, once specified, the process will be detached from the task scheduling system.
- `desc`: Description of the opener, display in interactive components, such as "Open with" and help menu.
- `for`: The opener is only available on this system; if not specified, it's available on all systems. Available values:
- `unix`: Linux and macOS
- `windows`: Windows
- `linux`: Linux
Expand Down
4 changes: 2 additions & 2 deletions docs/dds.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ yazi --remote-events=kind1,kind2
yazi --local-events=kind1,kind2 --remote-events=kind1,kind2
```

When an event of the specified kind is triggered, it will be output to `stdout`:
When an event of the specified kind is received, it will be output to `stdout`:

```sh
hover,0,200,{"tab":0,"url":"/root/Downloads"}
Expand Down Expand Up @@ -389,7 +389,7 @@ Source code: https://github.com/sxyazi/yazi/blob/main/yazi-plugin/preset/plugins

### `session.lua` {#session.lua}

The plugin provides cross-instance yank ability, which means you can yank files in one instance, and then paste them in another instance.
This plugin provides cross-instance yank ability, which means you can yank files in one instance, and then paste them in another instance.

To enable it, add these lines to your `init.lua`:

Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ When the user presses <kbd>j</kbd> or <kbd>k</kbd> to switch between hovering fi

| Key | Description |
| -------- | --------------------------------------------------------------------------------------------------------------------------- |
| `file` | The [File](/docs/plugins/types#app-data.folder-file) to be previewed. |
| `file` | The [File](/docs/plugins/types#shared.file) to be previewed. |
| `skip` | The number of units to skip. The units largely depend on your previewer, such as lines for code and percentages for videos. |
| `area` | The [Rect](/docs/plugins/layout#rect) of the available preview area. |
| `window` | The [Rect](/docs/plugins/layout#rect) of the entire terminal window. |
Expand All @@ -197,7 +197,7 @@ When the user presses <kbd>Alt-j</kbd> or <kbd>Alt-k</kbd> to scroll the preview

| Key | Description |
| ------ | -------------------------------------------------------------------- |
| `file` | The [File](/docs/plugins/types#app-data.folder-file) being scrolled. |
| `file` | The [File](/docs/plugins/types#shared.file) being scrolled. |
| `area` | The [Rect](/docs/plugins/layout#rect) of the available preview area. |

The task of `peek` is to draw in the preview area based on the values of `file` and `skip`. This process is asynchronous.
Expand Down

0 comments on commit 537d18e

Please sign in to comment.