diff --git a/docs/configuration/theme.md b/docs/configuration/theme.md index 09df0b02..8136c1b9 100644 --- a/docs/configuration/theme.md +++ b/docs/configuration/theme.md @@ -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 @@ -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] diff --git a/docs/faq.md b/docs/faq.md index 671e0e9e..35b8267d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -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? @@ -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. diff --git a/docs/quick-start.md b/docs/quick-start.md index 74b9d769..a6e825a2 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -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)!