From 89f949cb25cdc524a0271d90a4525b14c6b5e5cd Mon Sep 17 00:00:00 2001 From: sxyazi Date: Tue, 23 Apr 2024 22:57:58 +0800 Subject: [PATCH] docs: fix some typos and add a new section --- docs/dds.md | 8 ++++---- docs/image-preview.md | 6 ++++++ docs/tips.md | 4 ++-- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/dds.md b/docs/dds.md index 91c14fe5..bb34cddb 100644 --- a/docs/dds.md +++ b/docs/dds.md @@ -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} diff --git a/docs/image-preview.md b/docs/image-preview.md index 740dbb50..ad9c7c72 100644 --- a/docs/image-preview.md +++ b/docs/image-preview.md @@ -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: diff --git a/docs/tips.md b/docs/tips.md index bcd2dcd1..e0813507 100644 --- a/docs/tips.md +++ b/docs/tips.md @@ -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 @@ -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