Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify settings location #116

Merged
merged 2 commits into from
Oct 12, 2023
Merged

Clarify settings location #116

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3f21a5
Clarify settings location
joelostblom Oct 1, 2023
454d18d
Update modify-keybinds.md
joelostblom Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion modify-keybinds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ Jupyterlab commands don't know about the concept of vim modes so they will be ac

### Vim remappings

Vim style remappings (`inoremap`, `imap`, `nmap`...) can be modified in the advanced settings editor under the `Notebook Vim` settings. Alternatively, you can use the sibling extension [jupyterlab-vimrc](https://github.com/ianhi/jupyterlab-vimrc#jupyterlab-vimrc) to do this.
Vim style remappings (`inoremap`, `imap`, `nmap`...) can be modified in the Settings Editor under the `Notebook Vim` settings. Alternatively, for JupyterLab <4 you can use the sibling extension [jupyterlab-vimrc](https://github.com/ianhi/jupyterlab-vimrc#jupyterlab-vimrc) to do this.

With either approach, Vim remappings do not work with everything you may have in your standard vimrc. Jupyterlab uses [Codemirror] for the editors in cells. This extension adds vim support by enabling the [vim](https://github.com/replit/codemirror-vim) emulation in codemirror. While this comes with partial support for remappings in your vimrc the support is incomplete. In particular, keybindings which use `noremap` don't work [unless the keybinding already exists in the default Codemirror Vim keybindings](https://github.com/replit/codemirror-vim/blob/2242fb71a1954e516150de61d416f41bcd3f0e3c/src/vim.js#L799-L801). If your keybinding doesn't work with `noremap`, try using `map`, and above all, avoid recursive remappings.