diff options
| author | Canop <cano.petrole@gmail.com> | 2021-01-23 15:43:40 +0100 |
|---|---|---|
| committer | Canop <cano.petrole@gmail.com> | 2021-01-23 15:43:40 +0100 |
| commit | f5a20e515dcd9ae492a4955ed1ae0fa91dead434 (patch) | |
| tree | bef19550c794c561a920f343d2257c34463ac62c | |
| parent | cd7761b9e615a7375439962cbad07c159aabdd33 (diff) | |
prefer the "modal mode" name over "vim mode" in doc
| -rw-r--r-- | vim_mode.md | 40 | ||||
| -rw-r--r-- | website/docs/vim_mode.md | 2 | ||||
| -rw-r--r-- | website/mkdocs.yml | 2 |
3 files changed, 2 insertions, 42 deletions
diff --git a/vim_mode.md b/vim_mode.md deleted file mode 100644 index 8b02b5c..0000000 --- a/vim_mode.md +++ /dev/null @@ -1,40 +0,0 @@ - - -# Warnings - -1. DON'T activate this mode until you really tried broot. Broot isn't a text editor and can't be confused with one. This mode may be more comfortable when you constantly jump from vim to broot but only after you understood how broot works. -1. This isn't really about a "vim mode". This is about a "modal mode" in which single letter key shortcuts are possible because the input at the bottom isn't always focused. You may devise single letter shortcuts without taking inspiration in vim -1. You may be an avid vim user, as I am, and still prefer not to use modality in broot. Starting in *command* mode means you have one more letter to type before searching, because search is done in *input* mode. And broot is search oriented and often used in very short sessions (less than 5 seconds from intent to launch to being back in the shell in the right directory or editing the right file in your favorite editor) -1. The "modal mode" isn't yet released, you need to compile from source to use it. And it may change before release. -1. Rest of this page will assume you know broot - -# General idea - -Broot may be in one of two modes: - -1. **input** mode, with the input field at the bottom focused and received standard keys -1. **command** mode, with input not focused, and single key shortcuts enabled - -In *command* mode, you'll find those keys already configured: -* `j` and `k` to go down and up -* ̀ h` and `l` to go to parent or to enter a directory - -You enter *input* mode by typing one of those letters: ` ` (space), `:`, or `/`. You leave it with the `escape` key. You may add other bindings to the `:mode_input` and `:mode_command` verbs. - -# Configuration - -You need first to enable the "modal mode" with this line in the configuration: - -```hjson -modal: true -``` - -(or `modal = true` at the begining of the configuration if it's in TOML) - -If `modal` isn't set to `true`, the single letter shortcuts you define in configuration will be ignored (so you don't have to remove them if you don't want modality anymore). - -# Experimentation - -I'm waiting for feedback before finalizing and officially releasing this feature. - -Please tell me what you think and how it works for you on [miaou](https://miaou.dystroy.org/3490). diff --git a/website/docs/vim_mode.md b/website/docs/vim_mode.md index b99bd72..e8c6c6e 100644 --- a/website/docs/vim_mode.md +++ b/website/docs/vim_mode.md @@ -1,5 +1,5 @@ -# "Vim Mode" (or "Modal Mode") +# "Modal Mode" (aka "Vim Mode") ## Warnings diff --git a/website/mkdocs.yml b/website/mkdocs.yml index ad3fe1e..4c99e3c 100644 --- a/website/mkdocs.yml +++ b/website/mkdocs.yml @@ -23,7 +23,7 @@ nav: - Verbs and shortcuts: conf_verbs.md - Skins: skins.md - Icons: icons.md - - Vim Mode: vim_mode.md + - Modal Mode: vim_mode.md - Community: community.md extra_css: |