Skip to content

Commit

Permalink
docs: clarify the usage of flavors and configurations
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Dec 5, 2024
1 parent 4f0f5da commit 9495114
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/configuration/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ Then [copy the required part](https://github.com/sxyazi/yazi/blob/shipped/yazi-c
show_hidden = true
```

Yazi has already preset these default configurations in the release, so you don't need to copy the entire file unless you want to completely overwrite them.

## Configuration mixing {#mixing}

The options from your configuration file will be used to override the default. However, for key bindings, if you don't want to override the default directly:
Expand Down
4 changes: 3 additions & 1 deletion docs/flavors/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,15 @@ Where:

## Usage {#usage}

For example, if you want to use the `bar.yazi` flavor, add these lines to your `theme.toml`:
For example, if you want to use the `bar.yazi` flavor, set the content of your `theme.toml` to:

```toml
[flavor]
use = "bar"
```

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

## Why flavors over themes? {#why}

We recommend using the new flavor format instead of the old theme, because flavors:
Expand Down

0 comments on commit 9495114

Please sign in to comment.