catppuccin / yazi

🐥 Soothing pastel theme for Yazi

Catppuccin for Yazi

Previews

🌻 Latte

🪴 Frappé

🌺 Macchiato

🌿 Mocha

Usage

1. Copy the theme file of your choice from themes/ to your Yazi configuration directory with the filename theme.toml.
2. For Catppuccin-themed syntax highlighting in the preview pane:
   • Download the .tmTheme file of your choice from catppuccin/bat.
   • Replace the path of syntect_theme (line 32) with the path of your downloaded .tmTheme file.

Contributing

To contribute to this port you will need the following dependencies installed:

• Whiskers
• Deno

Edit yazi.tera to make changes to the theme. Run just build to build the output themes in themes/.

To update the icons data, you will additionally need Lua, LuaRocks, and the dkjson LuaRocks module. Run just icons to fetch and process the data from nvim-web-devicons.

💝 Thanks to

• uncenter

 

Copyright © 2021-present Catppuccin Org

yazi's Issues

Re-structure repository and potentially include `.tmTheme` files

Background

This issue assumes the context of the comments made in issue: catppuccin/catppuccin#2278 (comment)

I'm continuing the conversation in here to avoid valuable information being buried in a closed issue.

Description

I will provide a more explicit definition in the theme-making documentation/template for Yazi in the next few days - A Yazi theme that does not include a tmTheme file is considered an invalid theme, and each theme must be a directory.

- @sxyazi

Thanks for giving us a heads up! In regards to directory restructure, I think it then makes sense to have something like the following:

.
├── assets
│   └── latte.webp
│   └── frappe.webp
│   └── macchiato.webp
│   └── mocha.webp
│   └── preview.webp
├── frappe
│   └── theme.toml
├── latte
│   └── theme.toml
├── macchiato
│   └── theme.toml
├── mocha
│   └── theme.toml
├── README.md
├── LICENSE
└── ...

I understand that you'd like yazi themes to include the .tmTheme files in the same directory since it would be invalid and cause further inconvenience for the user. One potential "solution" is via git submodules if @uncenter is happy with managing the additional complexity. The .tmTheme files could be git symlinked into each directory, meaning the user could clone with git clone --recurse-submodules and then copy the files? However, I don't really believe this is worth it.

Personally, I still think its fine including the theme.toml files and telling users in the README to go download the .tmTheme file elsewhere, of course not ideal in yazi's case but I'd really like to avoid the duplication of files in the organisation.

 

The reason for making such a request is because I really love catppuccin and can't go a day without it. You might find it hard to believe that in earlier versions of Yazi, the color of catppuccin was hardcoded directly into the code, and it has appeared as the official theme until now. Therefore, I will be more stringent in my requirements for it.

- @sxyazi

I really appreciate how much you care about the theme, and I appreciate you being involved in this discussion. When it comes to decisions like the above, I'm looking at it from the perspective of the organisation as a whole.

Duplication of files ultimately harms the organisation overall as files may get updated in one place and not the other, and I'm okay with slightly inconveniencing the user's installation process in return for no duplicated files across repositories. I hope you can continue to understand my position on this.

syntect_theme line reference

Problem (minor and irrelevant issue)

There's a reference to the syntect_theme in the README.md file, which points to line 27, but, from the last version available, can be found in line 32 instead.

Solution

Just changing the reference to line 32.

Strange characters

I was setting yazi on my ubuntu, but could not make whatever this characters are. Is it supposed to be like this?
I've installed all the nerd fonts and tried find the hex code but nothing matches.

Support yazi flavors

Hi, here's an idea.

Flavors (BETA)
The "flavor" is a pre-made Yazi theme, while what we typically refer to as a "theme" is the user's own theme, i.e. ~/.config/yazi/theme.toml file.

The purpose of separating them is to allow users to customize their preferences more conveniently on top of an existing flavor, without having to modify those flavor files. This makes it easier to update, as there won't be conflicts when pulling from Git.

Behind the scenes, Yazi merges the user's theme.toml with the flavor's flavor.toml automatically, and the user's always takes precedence over the flavor.

https://yazi-rs.github.io/docs/flavors/overview

If you'd welcome a PR about this, please let me know and I can maybe contribute it.