Skip to content

Commit c08147b

Browse files
BAlmeidaSfirai
andauthored
README - transition between modes (#127)
* README - transition between modes * README code style * README lint * Reorganize new mode switching section and add link in mode description section * Lint * Change to <kbd> tags to address review comment --------- Co-authored-by: firai <[email protected]>
1 parent c791891 commit c08147b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ This extension combines the Jupyterlab (Edit and Command) modes with the standar
2626
- Normal
2727
- Visual
2828

29+
See [key bindings for switching between modes](#switching-between-modes).
30+
2931
## Install
3032

3133
```bash
@@ -103,6 +105,21 @@ Shortcuts this extension introduces:
103105
| Z, M | Hide All Code Cells |
104106
| Z, R | Show All Code Cells |
105107

108+
### Switching between modes
109+
110+
- From Command mode:
111+
- To enter Normal mode from Command mode, press <kbd>Enter</kbd>.
112+
- The extension blocks <kbd>Shift</kbd>+<kbd>Esc</kbd> from invoking browser commands, such as the browser task manager, by default. To disable the blocking behavior in Command mode, go to Settings menu → Settings Editor → Notebook Vim, and disable the "Override `Shift-Esc` browser shortcut in Jupyter Command mode" option.
113+
- From Normal mode:
114+
- To leave Normal mode to Command mode, several options are available:
115+
- <kbd>Shift</kbd>+<kbd>Esc</kbd>
116+
- <kbd>Esc</kbd> or <kbd>Ctrl</kbd>+<kbd>[</kbd>, if the "Enable `Esc` and `Ctrl-[` leaving vim Normal mode to Jupyter Command mode" option is enabled (on by default). To disable the option, go to Settings menu → Settings Editor → Notebook Vim.
117+
- To enter Insert mode from Normal mode, use one of the insert commmands, such as <kbd>i</kbd>, <kbd>I</kbd>, <kbd>a</kbd>, <kbd>A</kbd>, <kbd>o</kbd>, <kbd>O</kbd>, <kbd>c</kbd>, <kbd>C</kbd>, <kbd>s</kbd> or <kbd>S</kbd>.
118+
- To enter Visual Mode from Normal mode, use one of the visual commands, such as <kbd>v</kbd>, <kbd>V</kbd> or <kbd>Ctrl</kbd>+<kbd>V</kbd>.
119+
- From Insert or Visual modes:
120+
- To leave Insert or Visual modes to Normal Mode, press <kbd>Esc</kbd> or <kbd>Ctrl</kbd>+<kbd>[</kbd>.
121+
- To leave Insert or Visual modes to Command Mode, press <kbd>Shift</kbd>+<kbd>Esc</kbd>.
122+
106123
## Special Thanks
107124

108125
From @jwkvam:

0 commit comments

Comments
 (0)