Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 1.87 KB

README.md

File metadata and controls

57 lines (37 loc) · 1.87 KB
Raw
Yazi logo

Example Flavor for Yazi

Cooking up a new flavor

Note

Please remove this section from your README before publishing.

  1. Use this template and rename it to your-flavor-name.yazi.
  2. Copy the parts you need to customize from the default theme-dark.toml or theme-light.toml as ./flavor.toml, and change them to meet your preferences.
  3. Find a .tmTheme file on GitHub that matches the color of your flavor, copy it and its license file as ./tmtheme.xml, and LICENSE-tmtheme.
  4. Modify the content and preview image in the README to fit your flavor.

👀 Preview

🎨 Installation

ya pack -a username/example

⚙️ Usage

To set it as your dark flavor, change the content of your theme.toml to:

[flavor]
dark = "example"

Make sure your theme.toml doesn't contain anything other than [flavor], unless you want to override certain styles of this flavor.

See the Yazi flavor documentation for more details.

📜 License

The flavor is MIT-licensed, and the included tmTheme is also MIT-licensed.

Check the LICENSE and LICENSE-tmtheme file for more details.