Skip to content

Commit

Permalink
docs: fix some typos and add a new section
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Apr 23, 2024
1 parent a442e16 commit 89f949c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/dds.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ It deeply integrates with a publish-subscribe model based on the Lua API.

## Usage {#usage}

The DDS has two usage:
The DDS has three usage:

- [Plugin API](/docs/plugins/utils#ps): Using Lua-based publish-subscribe model as the carrier for DDS.
- [Command-line tool](#cli): Using `ya` command-line tool as the carrier for DDS.
- [Real-time `stdout` reporting](#stdout-reporting): Using `stdout` as the carrier for DDS.
- [Plugin API](/docs/plugins/utils#ps): Using Lua-based publish-subscribe model as the carrier.
- [Command-line tool](#cli): Using `ya` command-line tool as the carrier.
- [Real-time `stdout` reporting](#stdout-reporting): Using `stdout` as the carrier.

### Command-line tool {#cli}

Expand Down
6 changes: 6 additions & 0 deletions docs/image-preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ wezterm ssh 127.0.0.1

That's it! you can now get Yazi's image preview working properly.

## Neovim users {#neovim}

The builtin terminal emulator (`:term`) in Neovim [doesn't support any graphic protocols](https://github.com/neovim/neovim/issues/4349), so Yazi will try to fallback to X11/Wayland/Chafa in sequence.

Note that Überzug++ might display images in the wrong position; in that case, please adjust it manually using [`ueberzug_offset`](/docs/configuration/yazi/#preview.ueberzug_scale).

## Why can't I preview images via Überzug++? {#debug-ueberzug}

This may be an issue with Überzug++, please try running `ueberzugpp layer` directly in the terminal without Yazi, and paste:
Expand Down
4 changes: 2 additions & 2 deletions docs/tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ local function entry(_, args)

local target = parent.files[parent.cursor + 1 + args[1]]
if target and target.cha.is_dir then
ya.manager_emit("cd", { tostring(target.url) })
ya.manager_emit("cd", { target.url })
end
end

Expand All @@ -204,7 +204,7 @@ local function entry(_, args)
for i = start, end_, step do
local target = parent.files[i]
if target and target.cha.is_dir then
return ya.manager_emit("cd", { tostring(target.url) })
return ya.manager_emit("cd", { target.url })
end
end
end
Expand Down

0 comments on commit 89f949c

Please sign in to comment.