diff --git a/docs/configuration/overview.mdx b/docs/configuration/overview.mdx index baf92b13..b0bb6f86 100644 --- a/docs/configuration/overview.mdx +++ b/docs/configuration/overview.mdx @@ -7,9 +7,16 @@ description: Learn how to configure Yazi. # Configuration -You can find the preset configuration at: https://github.com/sxyazi/yazi/tree/main/yazi-config/preset. +There are multiple configuration files. They configure core yazi behavior, keymaps, and the theme, accordingly. -If you want to override the behavior as you like, please copy them to the following paths, to create and use your own configurations: +You can find the default configurations at: https://github.com/sxyazi/yazi/tree/main/yazi-config/preset. + +To override any of the defaults, begin by copying the appropriate file to following location: - Unix: `~/.config/yazi/` -- Windows: `C:\Users\YourName\AppData\Roaming\yazi\config\` +- Windows: `C:\Users\USERNAME\AppData\Roaming\yazi\config\` + +For example, to edit the keymaps, start by copying `keymap.toml` file (found [here](https://github.com/sxyazi/yazi/tree/main/yazi-config/preset)) to: + +- Unix: `~/.config/yazi/keymap.toml` +- Windows: `C:\Users\USERNAME\AppData\Roaming\yazi\config\keymap.toml`