docs: notes about keybinding conflict

Closes #147
This commit is contained in:
sxyazi
2025-09-16 22:57:33 +08:00
parent 109b13df29
commit d1c8baab86
10 changed files with 17 additions and 5 deletions

View File

@@ -21,7 +21,7 @@ run = "plugin chmod"
desc = "Chmod on selected files"
```
Make sure the <kbd>c</kbd> => <kbd>m</kbd> 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

View File

@@ -21,7 +21,7 @@ run = "plugin diff"
desc = "Diff the selected with the hovered file"
```
Make sure the <kbd>C</kbd> + <kbd>d</kbd> 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

View File

@@ -21,7 +21,7 @@ run = "plugin jump-to-char"
desc = "Jump to char"
```
Make sure the <kbd>f</kbd> 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

View File

@@ -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.

View File

@@ -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 |
| ------------ | ------------- | --------------------- |

View File

@@ -21,7 +21,7 @@ run = "plugin smart-filter"
desc = "Smart filter"
```
Make sure the <kbd>F</kbd> 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

View File

@@ -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.

View File

@@ -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:

View File

@@ -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)

View File

@@ -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: