diff options
| author | Griko Nibras <grikomsn@gmail.com> | 2018-10-05 04:47:36 +0700 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2018-10-04 23:47:36 +0200 |
| commit | 982e14cd3ac33951efd288c917f17ff6439951ab (patch) | |
| tree | e628e2ec1be3dc674555966937088c27da768ce0 | |
| parent | 2cb7bc7357ff70382bf15a775b534fd0fe559969 (diff) | |
| download | zsh-982e14cd3ac33951efd288c917f17ff6439951ab.tar.gz zsh-982e14cd3ac33951efd288c917f17ff6439951ab.tar.bz2 zsh-982e14cd3ac33951efd288c917f17ff6439951ab.zip | |
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"
| -rw-r--r-- | plugins/dircycle/README.md | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/plugins/dircycle/README.md b/plugins/dircycle/README.md index 9e1b3f644..3ac162f05 100644 --- a/plugins/dircycle/README.md +++ b/plugins/dircycle/README.md @@ -2,9 +2,7 @@ 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 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. +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. ## 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-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;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. |