docs: move image preview details to the website

This commit is contained in:
sxyazi 2024-02-20 00:15:40 +08:00
parent 3f27532c57
commit 8efafd6c91
No known key found for this signature in database
3 changed files with 8 additions and 21 deletions

View File

@ -32,9 +32,9 @@ body:
- type: dropdown
id: tried_main
attributes:
label: Did you try the latest main branch to see if the problem has already been fixed?
label: Did you try the latest main branch to see if the problem got fixed?
options:
- Tried, but the problem is still present
- Tried, but the problem still
- Not tried, and I'll explain why below
validations:
required: true

View File

@ -6,12 +6,14 @@ body:
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem? Please describe
label: Please describe the problem you're trying to solve
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: checkboxes
id: contribute
attributes:
label: Will you be willing to contribute this feature?
label: Would you be willing to contribute this feature?
description: The feature has a much higher chance of completion if you are willing to get involved!
options:
- label: Yes, I'll give it a shot
@ -22,11 +24,6 @@ body:
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: context
attributes:

View File

@ -51,18 +51,8 @@ https://github.com/sxyazi/yazi/assets/17523360/92ff23fa-0cd5-4f04-b387-894c12265
| X11 / Wayland | Window system protocol | ☑️ Überzug++ required |
| Fallback | [Chafa](https://hpjansson.org/chafa/) | ☑️ Überzug++ required |
Yazi automatically selects the appropriate preview method for you, based on the priority from top to bottom.
That's relying on the `$TERM`, `$TERM_PROGRAM`, and `$XDG_SESSION_TYPE` variables, make sure you don't overwrite them by mistake!
For instance, if your terminal is Alacritty, which doesn't support displaying images itself, but you are running on an X11/Wayland environment,
it will automatically use the "Window system protocol" to display images -- this requires you to have [Überzug++](https://github.com/jstkdng/ueberzugpp) installed.
Here is a guide for tmux users: [Image preview within tmux](https://github.com/sxyazi/yazi/wiki/Image-preview-within-tmux)
## TODO
See [Feature requests](https://github.com/sxyazi/yazi/issues/51) for more details.
See https://yazi-rs.github.io/docs/image-preview for details.
## License
Yazi is MIT licensed. For more information check the [LICENSE](LICENSE) file.
Yazi is MIT-licensed. For more information check the [LICENSE](LICENSE) file.