| .. | ||
| flavor.toml | ||
| LICENSE | ||
| LICENSE-tmtheme | ||
| preview.png | ||
| README.md | ||
| tmtheme.xml | ||
Example Flavor for Yazi
Cooking up a new flavor
Note
Please remove this section from your README before publishing.
- Fork this repository and rename it to
your-flavor-name.yazi. - Copy the parts you need to customize from the default theme.toml as
./flavor.toml, and change them to meet your preferences. - Find a
.tmThemefile on GitHub that matches the color of your flavor, copy it and it's license file as./tmtheme.xml, andLICENSE-tmtheme. - Modify the content and preview image in the README to fit your flavor.
👀 Preview
🎨 Installation
# Linux/macOS
git clone https://github.com/username/example.yazi.git ~/.config/yazi/flavors/example.yazi
# Windows
git clone https://github.com/username/example.yazi.git %AppData%\yazi\config\flavors\example.yazi
⚙️ Usage
Add the these lines to your theme.toml configuration file to use it:
[flavor]
use = "example"
📜 License
The flavor is MIT-licensed, and the included tmTheme is also MIT-licensed.
Check the LICENSE and LICENSE-tmtheme file for more details.