From 9495114c431e550822227b9831678fe681741beb Mon Sep 17 00:00:00 2001 From: sxyazi Date: Thu, 5 Dec 2024 23:47:48 +0800 Subject: [PATCH] docs: clarify the usage of flavors and configurations --- docs/configuration/overview.md | 2 ++ docs/flavors/overview.md | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/configuration/overview.md b/docs/configuration/overview.md index 787b391a..e305a7d5 100644 --- a/docs/configuration/overview.md +++ b/docs/configuration/overview.md @@ -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: diff --git a/docs/flavors/overview.md b/docs/flavors/overview.md index 4ac11ecf..1338bb8e 100644 --- a/docs/flavors/overview.md +++ b/docs/flavors/overview.md @@ -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: