Skip to content

Commit

Permalink
docs: remove nightly version mentions
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Aug 1, 2024
1 parent a09ad7c commit 4f655be
Show file tree
Hide file tree
Showing 8 changed files with 37 additions and 43 deletions.
22 changes: 11 additions & 11 deletions docs/configuration/keymap.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can change Yazi's keybindings in your `keymap.toml` file, which consists of
- [\[help\]](#help) - Help menu.

In each layer, there are two attributes: `prepend_keymap` and `append_keymap`.
Prepend inserts before [the default keybindings](https://github.com/sxyazi/yazi/blob/latest/yazi-config/preset/keymap.toml), while append inserts after them.
Prepend inserts before [the default keybindings](https://github.com/sxyazi/yazi/blob/shipped/yazi-config/preset/keymap.toml), while append inserts after them.

Since Yazi selects the first matching key to run, prepend always has a higher priority than default, and append always has a lower priority than default:

Expand Down Expand Up @@ -159,7 +159,7 @@ run = "cd ~/Pictures"
desc = "Cd to ~/Pictures"
```

For Windows users, you can also switch drives using the `cd` command (Nightly version of Yazi required atm):
For Windows users, you can also switch drives using the `cd` command:

```toml
[[manager.prepend_keymap]]
Expand Down Expand Up @@ -258,11 +258,11 @@ Move the files to the trash/recycle bin on macOS/Windows. For Linux, it will fol

In the Android platform, you can only use it with the `--permanently` option, since there lacks the concept of a trash bin.

| Argument/Option | Description |
| --------------- | ----------------------------------------------------------------------------------------------------------- |
| `--force` | Don't show the confirmation dialog, and trash/delete files directly. |
| `--permanently` | Permanently delete the files. |
| `--hovered` | Always remove the hovered file regardless of the selection state. (Nightly version of Yazi is required ATM) |
| Argument/Option | Description |
| --------------- | -------------------------------------------------------------------- |
| `--force` | Don't show the confirmation dialog, and trash/delete files directly. |
| `--permanently` | Permanently delete the files. |
| `--hovered` | Always remove the hovered file regardless of the selection state. |

### `create` {#manager.create}

Expand All @@ -276,7 +276,7 @@ Create a file or directory. Ends with `/` (Unix) or `\` (Windows) for directorie

Rename a file or directory, or bulk rename if multiple files are selected (`$EDITOR` is used to edit the filenames by default).

- `--hovered`: Always rename the hovered file regardless of the selection state. (Nightly version of Yazi is required ATM)
- `--hovered`: Always rename the hovered file regardless of the selection state.
- `--force`: Overwrite the destination file directly if it exists, without showing the confirmation dialog.
- `--empty`: Empty a part of the filename.
- `"stem"`: Empty the stem. e.g. `"foo.jpg"` -> `".jpg"`.
Expand Down Expand Up @@ -340,17 +340,17 @@ Set the [line mode](/docs/configuration/yazi#manager.linemode).
| `size` | Display the size in bytes of the file. Since file sizes are only evaluated when sorting by size, it only works after [`sort_by = "size"`](/docs/configuration/yazi#manager.sort_by) set, and this behavior might change in the future. |
| `permissions` | Display the permissions of the file, only available on Unix-like systems. |
| `mtime` | Display the last modified time of the file. |
| `owner` | Display the owner of the file, only available on Unix-like systems. (Nightly version of Yazi required atm) |
| `owner` | Display the owner of the file, only available on Unix-like systems. |

In addition, you can also specify any 1 to 20 characters, and extend it within a UI plugin.
Which means you can implement your own linemode through the plugin by simply overriding the [`Folder:linemode` method](https://github.com/sxyazi/yazi/blob/latest/yazi-plugin/preset/components/folder.lua).
Which means you can implement your own linemode through the plugin by simply overriding the [`Folder:linemode` method](https://github.com/sxyazi/yazi/blob/shipped/yazi-plugin/preset/components/folder.lua).

### `search` {#manager.search}

| Argument/Option | Description |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `[engine]` | Search engine, available values: [`fd`](https://github.com/sharkdp/fd), [`rg`](https://github.com/BurntSushi/ripgrep), `none` (cancel search) |
| `--args` | Additional arguments passed to the specified engine, for example `search fd --args='-e -H'` (Nightly version of Yazi required atm) |
| `--args` | Additional arguments passed to the specified engine, for example `search fd --args='-e -H'` |

You can search with an empty keyword (`""`) via `fd` to achieve flat view.

Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ There are three configuration files for Yazi:
- [`keymap.toml`](/docs/configuration/keymap) - Keybindings configuration.
- [`theme.toml`](/docs/configuration/theme) - Color scheme configuration.

You can find the default configuration files on the **_`latest`_** tag [https://github.com/sxyazi/yazi/tree/**_latest_**/yazi-config/preset](https://github.com/sxyazi/yazi/tree/latest/yazi-config/preset).
You can find the default configuration files on the **_`shipped`_** tag [https://github.com/sxyazi/yazi/tree/**_shipped_**/yazi-config/preset](https://github.com/sxyazi/yazi/tree/shipped/yazi-config/preset).

To override any of the defaults, begin by creating the corresponding file (from the directory linked above) to:

Expand All @@ -25,7 +25,7 @@ For example, to change the visible status of hidden files, start by creating a `
- `~/.config/yazi/yazi.toml` on Unix-like systems.
- `C:\Users\USERNAME\AppData\Roaming\yazi\config\yazi.toml` on Windows.

Then [copy the required part](https://github.com/sxyazi/yazi/blob/latest/yazi-config/preset/yazi.toml) into it, here is `show_hidden`:
Then [copy the required part](https://github.com/sxyazi/yazi/blob/shipped/yazi-config/preset/yazi.toml) into it, here is `show_hidden`:

```toml
# yazi.toml
Expand Down
10 changes: 4 additions & 6 deletions docs/configuration/yazi.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Display directories first.

Transliterate filenames for sorting (i.e. replaces `Â` as `A`, `Æ` as `AE`, etc.), only available if `sort_by = "natural"`.

This is useful for files that contain Hungarian characters. (Currently requires nightly builds.)
This is useful for files that contain Hungarian characters.

- `true`: Enabled
- `false`: Disabled
Expand All @@ -67,10 +67,10 @@ Line mode: display information associated with the file on the right side of the
- `"size"`: Display the size in bytes of the file. Since file sizes are only evaluated when sorting by size, it only works after [`sort_by = "size"`](/docs/configuration/yazi#manager.sort_by) set, and this behavior might change in the future.
- `"permissions"`: Display the permissions of the file, only available on Unix-like systems.
- `"mtime"`: Display the last modified time of the file.
- `"owner"`: Display the owner of the file, only available on Unix-like systems. (Nightly version of Yazi required atm)
- `"owner"`: Display the owner of the file, only available on Unix-like systems.

In addition, you can also specify any 1 to 20 characters, and extend it within a UI plugin.
Which means you can implement your own linemode through the plugin by simply overriding the [`Folder:linemode` method](https://github.com/sxyazi/yazi/blob/latest/yazi-plugin/preset/components/folder.lua).
Which means you can implement your own linemode through the plugin by simply overriding the [`Folder:linemode` method](https://github.com/sxyazi/yazi/blob/shipped/yazi-plugin/preset/components/folder.lua).

### `show_hidden` {#manager.show_hidden}

Expand Down Expand Up @@ -102,8 +102,6 @@ Array of strings, the types of mouse events can be received by the plugin system
- `"move"`: Mouse move
- `"drag"`: Mouse drag (Some terminals do not support this)

Currently needs the nightly version of Yazi.

## [preview] {#preview}

### `tab_size` {#preview.tab_size}
Expand Down Expand Up @@ -212,7 +210,7 @@ append_rules = [
]
```

If your `append_rules` contains wildcard rules, they will always take precedence over the default wildcard rules as the fallback (Currently requires nightly builds).
If your `append_rules` contains wildcard rules, they will always take precedence over the default wildcard rules as the fallback.

Or, use `rules` to rewrite the entire default rules:

Expand Down
4 changes: 0 additions & 4 deletions docs/dds.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,6 @@ rename,0,1711957878076791,{"tab":0,"from":"/root/foo.txt","to":"/root/bar.txt"}

### `bulk` - bulk rename files {#bulk}

:::note
This kind currently requires the nightly version of Yazi.
:::

`sub()` / `sub_remote()` callback body:

```lua
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ The task of `peek` is to draw in the preview area based on the values of `file`

The task of `seek` is to change the value of `skip` based on user behavior and trigger `peek` again. It is synchronous, meaning you can access [app data](/docs/plugins/types#app-data) through `cx`.

Here are some preset previewers and preloaders you can refer to: [Yazi Preset Plugins](https://github.com/sxyazi/yazi/tree/latest/yazi-plugin/preset/plugins)
Here are some preset previewers and preloaders you can refer to: [Yazi Preset Plugins](https://github.com/sxyazi/yazi/tree/shipped/yazi-plugin/preset/plugins)

### Preloader {#preloader}

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Request user input:
- `w`: Required, the width of the input, which is an positive integer.
- `h`: Optional, the height of the input, which is an positive integer.
- `realtime`: Optional, whether to report user input in real time, which is a boolean.
- `debounce`: Optional, the number of seconds to wait for the user to stop typing, which is a positive float. Can only be used when `realtime = true`. (Currently needs the nightly version of Yazi)
- `debounce`: Optional, the number of seconds to wait for the user to stop typing, which is a positive float. Can only be used when `realtime = true`.

```lua
local value, event = ya.input {
Expand Down
34 changes: 17 additions & 17 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ To use it, copy the function into the configuration file of your respective shel
## Keybindings
:::tip
For all keybindings, see the [default `keymap.toml` file](https://github.com/sxyazi/yazi/blob/latest/yazi-config/preset/keymap.toml).
For all keybindings, see the [default `keymap.toml` file](https://github.com/sxyazi/yazi/blob/shipped/yazi-config/preset/keymap.toml).
:::
### Navigation
Expand Down Expand Up @@ -192,21 +192,21 @@ To sort files/directories use the following commands.
_Observation: <kbd>,</kbd> ⇒ <kbd>a</kbd> indicates pressing the <kbd>,</kbd> key followed by pressing the <kbd>a</kbd> key._
| Key binding | Action |
| --------------------------- | ------------------------------------- |
| <kbd>,</kbd> ⇒ <kbd>m</kbd> | Sort by modified time |
| <kbd>,</kbd> ⇒ <kbd>M</kbd> | Sort by modified time (reverse) |
| <kbd>,</kbd> ⇒ <kbd>c</kbd> | Sort by creation time |
| <kbd>,</kbd> ⇒ <kbd>C</kbd> | Sort by creation time (reverse) |
| <kbd>,</kbd> ⇒ <kbd>e</kbd> | Sort by file extension |
| <kbd>,</kbd> ⇒ <kbd>E</kbd> | Sort by file extension (reverse) |
| <kbd>,</kbd> ⇒ <kbd>a</kbd> | Sort alphabetically |
| <kbd>,</kbd> ⇒ <kbd>A</kbd> | Sort alphabetically (reverse) |
| <kbd>,</kbd> ⇒ <kbd>n</kbd> | Sort naturally |
| <kbd>,</kbd> ⇒ <kbd>N</kbd> | Sort naturally (reverse) |
| <kbd>,</kbd> ⇒ <kbd>s</kbd> | Sort by size |
| <kbd>,</kbd> ⇒ <kbd>S</kbd> | Sort by size (reverse) |
| <kbd>,</kbd> ⇒ <kbd>r</kbd> | Sort randomly (Nightly version needs) |
| Key binding | Action |
| --------------------------- | -------------------------------- |
| <kbd>,</kbd> ⇒ <kbd>m</kbd> | Sort by modified time |
| <kbd>,</kbd> ⇒ <kbd>M</kbd> | Sort by modified time (reverse) |
| <kbd>,</kbd> ⇒ <kbd>c</kbd> | Sort by creation time |
| <kbd>,</kbd> ⇒ <kbd>C</kbd> | Sort by creation time (reverse) |
| <kbd>,</kbd> ⇒ <kbd>e</kbd> | Sort by file extension |
| <kbd>,</kbd> ⇒ <kbd>E</kbd> | Sort by file extension (reverse) |
| <kbd>,</kbd> ⇒ <kbd>a</kbd> | Sort alphabetically |
| <kbd>,</kbd> ⇒ <kbd>A</kbd> | Sort alphabetically (reverse) |
| <kbd>,</kbd> ⇒ <kbd>n</kbd> | Sort naturally |
| <kbd>,</kbd> ⇒ <kbd>N</kbd> | Sort naturally (reverse) |
| <kbd>,</kbd> ⇒ <kbd>s</kbd> | Sort by size |
| <kbd>,</kbd> ⇒ <kbd>S</kbd> | Sort by size (reverse) |
| <kbd>,</kbd> ⇒ <kbd>r</kbd> | Sort randomly |
### Multi-tab
Expand All @@ -218,7 +218,7 @@ _Observation: <kbd>,</kbd> ⇒ <kbd>a</kbd> indicates pressing the <kbd>,</kbd>
| <kbd>]</kbd> | Switch to the next tab |
| <kbd>\{</kbd> | Swap current tab with previous tab |
| <kbd>}</kbd> | Swap current tab with next tab |
| <kbd>Ctrl</kbd> + <kbd>q</kbd> (<kbd>Ctrl</kbd> + <kbd>c</kbd> on nightly) | Close the current tab |
| <kbd>Ctrl</kbd> + <kbd>c</kbd> | Close the current tab |
## Flavors
Expand Down
2 changes: 1 addition & 1 deletion docs/tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ end

<img src={useBaseUrl("/img/symlink-in-status.png")} width="600" />

Copy the [`Status:name()` method](https://github.com/sxyazi/yazi/blob/latest/yazi-plugin/preset/components/status.lua) _*only*_ to your `~/.config/yazi/init.lua`, and apply the following patch:
Copy the [`Status:name()` method](https://github.com/sxyazi/yazi/blob/shipped/yazi-plugin/preset/components/status.lua) _*only*_ to your `~/.config/yazi/init.lua`, and apply the following patch:

```diff
@@ -42,7 +42,11 @@ function Status:name()
Expand Down

0 comments on commit 4f655be

Please sign in to comment.