Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add README for default configuration files #2005

Merged
merged 3 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion yazi-adapter/src/emulator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ impl Emulator {
}

fn cell_size(resp: &str) -> Option<(u16, u16)> {
let b = resp.split_at(resp.find("\x1b[6;")? + 4).1.as_bytes();
let b = resp.split_once("\x1b[6;")?.1.as_bytes();

let h: Vec<_> = b.iter().copied().take_while(|&c| c.is_ascii_digit()).collect();
b.get(h.len()).filter(|&&c| c == b';')?;
Expand Down
40 changes: 40 additions & 0 deletions yazi-config/preset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Default Configuration

> [!IMPORTANT]
> If you're using a stable release of Yazi instead of the latest nightly build, make sure you're checking these files from [the shipped tag][shipped], not the latest main branch.

This directory contains the default configuration files for Yazi:

- [`yazi-default.toml`][yazi-default]: General configuration
- [`keymap-default.toml`][keymap-default]: Keybindings configuration
- [`theme-dark.toml`][theme-dark]: Dark color scheme (loaded when your terminal is in dark mode)
- [`theme-light.toml`][theme-light]: Light color scheme (loaded when your terminal is in light mode)

These files are already included with Yazi when you install the release, so you don't need to manually download or copy them to your Yazi configuration directory.

However, if you want to customize certain configurations:

- Create a `yazi.toml` in your config directory to override the settings in [`yazi-default.toml`][yazi-default], so either:
- `~/.config/yazi/yazi.toml` on Unix-like systems
- `C:\Users\USERNAME\AppData\Roaming\yazi\config\yazi.toml` on Windows
- Create a `keymap.toml` in your config directory to override the settings in [`keymap-default.toml`][keymap-default], so either:
- `~/.config/yazi/keymap.toml` on Unix-like systems
- `C:\Users\USERNAME\AppData\Roaming\yazi\config\keymap.toml` on Windows
- Create a `theme.toml` in your config directory to override the settings in [`theme-light.toml`][theme-light] and [`theme-dark.toml`][theme-dark], so either:
- `~/.config/yazi/theme.toml` on Unix-like systems
- `C:\Users\USERNAME\AppData\Roaming\yazi\config\theme.toml` on Windows

For the user's `theme.toml` file, you can only apply the same color scheme to both the light and dark themes.

If you want more granular control over colors, specify two different flavors for light and dark modes under the `[flavor]` section of your `theme.toml`, and override them in your respective flavor instead.

[shipped]: https://github.com/sxyazi/yazi/tree/shipped
[yazi-default]: yazi-default.toml
[keymap-default]: keymap-default.toml
[theme-dark]: theme-dark.toml
[theme-light]: theme-light.toml

## Learn more

- [Configuration documentation](https://yazi-rs.github.io/docs/configuration/overview)
- [Flavors documentation](https://yazi-rs.github.io/docs/flavors/overview)
File renamed without changes.
File renamed without changes.
11 changes: 8 additions & 3 deletions yazi-macro/src/asset.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ macro_rules! config_preset {
#[cfg(debug_assertions)]
{
std::borrow::Cow::from(
std::fs::read_to_string(concat!(env!("CARGO_MANIFEST_DIR"), "/preset/", $name, ".toml"))
.expect(concat!("Failed to read 'yazi-config/preset/", $name, ".toml'")),
std::fs::read_to_string(concat!(
env!("CARGO_MANIFEST_DIR"),
"/preset/",
$name,
"-default.toml"
))
.expect(concat!("Failed to read 'yazi-config/preset/", $name, "-default.toml'")),
)
}
#[cfg(not(debug_assertions))]
Expand All @@ -14,7 +19,7 @@ macro_rules! config_preset {
env!("CARGO_MANIFEST_DIR"),
"/preset/",
$name,
".toml"
"-default.toml"
)))
}
}};
Expand Down
Loading