From d1c8baab86100afb708694d22b13901b9f9baf00 Mon Sep 17 00:00:00 2001 From: sxyazi Date: Tue, 16 Sep 2025 22:57:33 +0800 Subject: [PATCH] docs: notes about keybinding conflict Closes #147 --- chmod.yazi/README.md | 2 +- diff.yazi/README.md | 2 +- jump-to-char.yazi/README.md | 2 +- mactag.yazi/README.md | 2 ++ mount.yazi/README.md | 4 +++- smart-filter.yazi/README.md | 2 +- smart-paste.yazi/README.md | 2 ++ toggle-pane.yazi/README.md | 2 ++ vcs-files.yazi/README.md | 2 ++ zoom.yazi/README.md | 2 ++ 10 files changed, 17 insertions(+), 5 deletions(-) diff --git a/chmod.yazi/README.md b/chmod.yazi/README.md index b2ad136..74616a7 100644 --- a/chmod.yazi/README.md +++ b/chmod.yazi/README.md @@ -21,7 +21,7 @@ run = "plugin chmod" desc = "Chmod on selected files" ``` -Make sure the c => m key is not used elsewhere. +Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins. ## License diff --git a/diff.yazi/README.md b/diff.yazi/README.md index 1976541..4203a8c 100644 --- a/diff.yazi/README.md +++ b/diff.yazi/README.md @@ -21,7 +21,7 @@ run = "plugin diff" desc = "Diff the selected with the hovered file" ``` -Make sure the C + d key is not used elsewhere. +Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins. ## License diff --git a/jump-to-char.yazi/README.md b/jump-to-char.yazi/README.md index d24f2e7..3658c35 100644 --- a/jump-to-char.yazi/README.md +++ b/jump-to-char.yazi/README.md @@ -21,7 +21,7 @@ run = "plugin jump-to-char" desc = "Jump to char" ``` -Make sure the f key is not used elsewhere. +Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins. ## License diff --git a/mactag.yazi/README.md b/mactag.yazi/README.md index e5c060b..211b09f 100644 --- a/mactag.yazi/README.md +++ b/mactag.yazi/README.md @@ -74,6 +74,8 @@ run = "plugin mactag remove" desc = "Untag selected files" ``` +Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins. + ## License This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file. diff --git a/mount.yazi/README.md b/mount.yazi/README.md index b35881f..20a5615 100644 --- a/mount.yazi/README.md +++ b/mount.yazi/README.md @@ -25,7 +25,9 @@ on = "M" run = "plugin mount" ``` -Available keybindings: +Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins. + +## Actions | Key binding | Alternate key | Action | | ------------ | ------------- | --------------------- | diff --git a/smart-filter.yazi/README.md b/smart-filter.yazi/README.md index 97be2ac..31872e6 100644 --- a/smart-filter.yazi/README.md +++ b/smart-filter.yazi/README.md @@ -21,7 +21,7 @@ run = "plugin smart-filter" desc = "Smart filter" ``` -Make sure the F key is not used elsewhere. +Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins. ## License diff --git a/smart-paste.yazi/README.md b/smart-paste.yazi/README.md index b32f475..5daa259 100644 --- a/smart-paste.yazi/README.md +++ b/smart-paste.yazi/README.md @@ -21,6 +21,8 @@ run = "plugin smart-paste" desc = "Paste into the hovered directory or CWD" ``` +Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins. + ## License This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file. diff --git a/toggle-pane.yazi/README.md b/toggle-pane.yazi/README.md index 3ef4095..ba70f1f 100644 --- a/toggle-pane.yazi/README.md +++ b/toggle-pane.yazi/README.md @@ -42,6 +42,8 @@ desc = "Maximize or restore the preview pane" You can replace `preview` with `current` or `parent` to toggle the other panes. +Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins. + ## Advanced In addition to triggering the plugin with a keypress, you can also trigger it in your `init.lua` file: diff --git a/vcs-files.yazi/README.md b/vcs-files.yazi/README.md index 4888134..7997d27 100644 --- a/vcs-files.yazi/README.md +++ b/vcs-files.yazi/README.md @@ -20,6 +20,8 @@ run = "plugin vcs-files" desc = "Show Git file changes" ``` +Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins. + ## TODO - [ ] Add support for other VCS (e.g. Mercurial, Subversion) diff --git a/zoom.yazi/README.md b/zoom.yazi/README.md index 9be8025..98a34e7 100644 --- a/zoom.yazi/README.md +++ b/zoom.yazi/README.md @@ -37,6 +37,8 @@ run = "plugin zoom -1" desc = "Zoom out hovered file" ``` +Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins. + ## Advanced If you want to apply a default zoom parameter to image previews, you can specify it while setting this plugin up as a custom previewer, for example: