Skip to content

Commit

Permalink
docs: update themes to flavors
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Mar 17, 2024
1 parent 0a01d63 commit 241e427
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
7 changes: 3 additions & 4 deletions docs/configuration/theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Learn how to configure your Yazi theme.
# theme.toml

:::tip
If you're looking for ready-made themes and don't want to create one yourself, check out the [yazi-rs/themes](https://github.com/yazi-rs/themes) repository.
If you're looking for ready-made themes and don't want to create one yourself, check out the [yazi-rs/flavors](https://github.com/yazi-rs/flavors) repository.
:::

## Types
Expand Down Expand Up @@ -82,10 +82,9 @@ Border:

Highlighting: The built-in syntax highlighting feature

- syntect_theme (String): Theme file path ending with ".tmTheme", used by syntect. e.g. `"~/my-themes/Dracula.tmTheme"`.
- syntect_theme (String): For example, `"~/Downloads/Dracula.tmTheme"`. Only available in the user's `theme.toml` and cannot be used in [`flavor.toml`](/docs/flavors/overview).

Yazi and `bat` use the same highlighter [syntect](https://crates.io/crates/syntect), so you can directly use [bat's theme files](https://github.com/sharkdp/bat/tree/master/assets/themes).
You can also find more available themes on GitHub by using the keyword "tmTheme".
Yazi's builtin code highlighting themes, which are paths to `.tmTheme` files. You can find them on GitHub [using "tmTheme" as a keyword](https://github.com/search?q=tmTheme&type=repositories)

## [status]

Expand Down
4 changes: 2 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Yazi's default theme uses base16 colors to match the user's terminal theme as cl

Unfortunately, this cannot cater to all users, and even the colors needed by the same user in light/dark mode can vary, not to mention that some terminals have poor default color schemes, like this [#149 (comment)](https://github.com/sxyazi/yazi/issues/149#issuecomment-1798349727).

So, please [use a Yazi theme](https://github.com/yazi-rs/themes) that matches your terminal theme. Of course, if you find a color that better covers most terminals, feel free to create a PR!
So, please [use a Yazi flavor](https://github.com/yazi-rs/flavors) that matches your terminal theme. Of course, if you find a color that better covers most terminals, feel free to create a PR!

## Why can't "Open" and "Enter" be a single command?

Expand All @@ -44,7 +44,7 @@ If you truly don't need to distinguish between them, use this [smart-enter tip](

## Why do my icons shrink in [kitty](https://sw.kovidgoyal.net/kitty/), and enlarge when scrolling?

TL;DR: Use a theme for Yazi, https://github.com/yazi-rs/themes
TL;DR: Use a theme for Yazi, https://github.com/yazi-rs/flavors

This might be a bug in kitty (or feature? I don't know). In kitty, you have to add a style to file list items (like foreground color) to make the icons match the text size. However, Yazi's default theme can't add that color, because it can't predict whether the user's terminal has a white background with black text, or a black background with white text.

Expand Down
4 changes: 2 additions & 2 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,6 @@ _Observation: `, ⇒ a` indicates pressing the `,` key followed by pressing the
| , ⇒ s | Sort by size |
| , ⇒ S | Sort by size (reverse) |
## Themes
## Flavors
Check out our [themes repository](https://github.com/yazi-rs/themes), [suggest a new one](https://github.com/yazi-rs/themes/issues/new), or [make your own](./configuration/theme.md)!
Check out our [flavors repository](https://github.com/yazi-rs/flavors), or [cooking a flavor](/docs/flavors/overview#cooking-a-flavor)!

0 comments on commit 241e427

Please sign in to comment.