dircycle: improve README (#7223)

+ changed keypresses to use the <kbd> tag
+ added "rebinding keys" section
- removed line break on description
- removed line break on "rebinding keys"
This commit is contained in:
Griko Nibras 2018-10-05 04:47:36 +07:00 committed by Marc Cornellà
parent 2cb7bc7357
commit 982e14cd3a

View file

@ -2,9 +2,7 @@
Plugin for cycling through the directory stack Plugin for cycling through the directory stack
This plugins enables directory navigation similar when using back and forward on browsers or common file explorers like Finder or Nautilus. This plugin enables directory navigation similar to using back and forward on browsers or common file explorers like Finder or Nautilus. It uses a small zle trick that lets you cycle through your directory stack left or right using <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Left</kbd> / <kbd>Right</kbd> . This is useful when moving back and forth between directories in development environments, and can be thought of as kind of a nondestructive pushd/popd.
This is a small zle trick that lets you cycle your directory stack left or right using Ctrl+Shift+Left/Right. This is useful when moving back and forth between directories in development environments, and can be thought of as kind of a nondestructive pushd/popd.
## Enabling the plugin ## Enabling the plugin
@ -68,12 +66,13 @@ Here's an asciinema cast demonstrating the example above:
| `insert-cycledleft` | Change `$CWD` to the previous known stack, binded on <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Left</kbd> | | `insert-cycledleft` | Change `$CWD` to the previous known stack, binded on <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Left</kbd> |
| `insert-cycledright` | Change `$CWD` to the next known stack, binded on <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Right</kbd> | | `insert-cycledright` | Change `$CWD` to the next known stack, binded on <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Right</kbd> |
You can bind these functions to other key sequences, as long as you know the bindkey sequence: ## Rebinding keys
For example, these commands bind to Alt+Shift+Left/Right in xterm-256color: You can bind these functions to other key sequences, as long as you know the bindkey sequence. For example, these commands bind to <kbd>Alt</kbd> + <kbd>Shift</kbd> + <kbd>Left</kbd> / <kbd>Right</kbd> in `xterm-256color`:
```
```zsh
bindkey '^[[1;4D' insert-cycledleft bindkey '^[[1;4D' insert-cycledleft
bindkey '^[[1;4C' insert-cycledright bindkey '^[[1;4C' insert-cycledright
``` ```
You can get the bindkey sequence pressing <kbd>Ctrl</kbd> + <kbd>V</kbd>, then pressing the keyboard shortcut you want to use. You can get the bindkey sequence by pressing <kbd>Ctrl</kbd> + <kbd>V</kbd>, then pressing the keyboard shortcut you want to use.