Skip to content

Commit

Permalink
docs: update image-preview.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Oct 19, 2024
1 parent 078ab9e commit baaab56
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/image-preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ Currently, only the following 3 terminals support displaying images on Windows:

Limited by ConPTY, the Windows edition has had to implement many workarounds, which are not perfect.

However, if you run Yazi in WSL, you can experience perfect image previews using `wezterm ssh`.<br/>
[WezTerm](https://wezfurlong.org/wezterm/) is an excellent terminal that can bypass the limitations of ConPTY through its SSH feature, and it's currently the only terminal that allows this approach.
However, if you run Yazi in WSL, you can experience perfect image previews through [`wezterm ssh`][wezterm-ssh].<br/>
[WezTerm][wezterm] is an excellent terminal that can bypass the limitations of ConPTY through its SSH feature, and it's currently the only terminal that allows this approach.

You need to install `sshd` in WSL and start it:

Expand All @@ -103,14 +103,17 @@ sudo apt install openssh-server
sudo service ssh restart
```

Then, on the host machine, connect to WSL over SSH:
Then, on the _host_ machine, connect to WSL over SSH:

```sh
wezterm ssh 127.0.0.1
```

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

[wezterm]: https://wezfurlong.org/wezterm/
[wezterm-ssh]: https://wezfurlong.org/wezterm/cli/ssh.html

## 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.
Expand Down

0 comments on commit baaab56

Please sign in to comment.