https://github.com/yazi-rs/flavor-template

Yazi flavor starter template.
https://github.com/yazi-rs/flavor-template

Last synced: 11 days ago
JSON representation

Yazi flavor starter template.

• Host: GitHub
• URL: https://github.com/yazi-rs/flavor-template
• Owner: yazi-rs
• License: other
• Created: 2024-02-25T17:14:56.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-08-08T03:33:40.000Z (3 months ago)
• Last Synced: 2024-08-08T05:04:24.532Z (3 months ago)
• Homepage:
• Size: 645 KB
• Stars: 8
• Watchers: 1
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  





	Example Flavor for Yazi



## Cooking up a new flavor

> [!NOTE]

> Please remove this section from your README before publishing.

1. [x] Fork this repository and rename it to `your-flavor-name.yazi`.

2. [ ] Copy the **parts you need to customize** from the [default theme.toml](https://github.com/sxyazi/yazi/blob/main/yazi-config/preset/theme.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 it's license file as `./tmtheme.xml`, and `LICENSE-tmtheme`.

4. [ ] Modify the content and preview image in the README to fit your flavor.

## 👀 Preview



## 🎨 Installation

```bash

ya pack -a username/example

```

## ⚙️ Usage

Add the these lines to your `theme.toml` configuration file to use it:

```toml

[flavor]

use = "example"

```

## 📜 License

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

Check the [LICENSE](LICENSE) and [LICENSE-tmtheme](LICENSE-tmtheme) file for more details.