Overleaf Editor Custom VIM Keybindings

Configure a list of shortcuts for Vim-mode + :commands for toggling panes on Overleaf

Author
llinfeng
Daily installs
0
Total installs
128
Ratings
1 0 0
Version
0.3.7
Created
2020-04-16
Updated
2022-05-12
License
MIT
Applies to

Full Credits to Harutyun Amirjanyan for the jump-to-PDF script, as found on the Ace forum, in this post.

List of mappings defined here:

  • imap jj <esc> and imap jk <esc>
  • nmap j gj and nmap k gk (so far, we cannot mapt g0 in Ace editor.)
  • \lv and ;lv are triggering the following button image
  • ,v to toggle the file-tree on the left.
  • ,o to enter editor-only mode: it hides the file panel and the PDF preview pane. (Caveat: if file-tree is hidden and PDF view is alive, this shortcut will show the file-tree and hide PDF.)
  • :o in Commandline, to hide box below the editor pane, introduced by the "Omega" icon to the right of "Source | Rich Text".
  • :pdf in Commandline, to toggle the PDF pane on the right. Alias include: :PDF, :ShowPDF, :ClosePDF, :OpenPDF.
  • :cc in Commandline, to toggle the Comment panel. Alias include: :CC, :CloseComment.
  • :home in Commandline, to get back to the "All Projects" view.
  • :log in Commandline, to toggle the "CompileLog"
  • With Writefull, use ] and [ to jump to the next/previous spell-checking suggestion.
    • With the suggestion card, use 1, 2, 3 to select over the options offered. It doesn't matter how the suggestion card is brought up. As long as it is visible, one can select over the candidates using 1, 2, 3.

Visually, a vertical divider is drawn at the 80th column. All lines with more than 80 cols are wrapped at 80th column.

Note, this script unmaps ctrl+l, leaving it available for the browser.

It should be plug-and-play, and include settings of the following sort.

  1. nmap and vmap;
  2. unmap certain special keys. (For now, ; and , are specially reserved for unknown purposes.)
  3. command! Short LongCommand, where :Short can be callable. And, in TamperMonkey, the LongCommand needs to be specified through JavaScript.

Troubleshooting

  1. If the PDF fails to compile, TogglePDF won't work as intended. (This impacts the :pdf command and the <leader>o mapping.)
  2. (Added on 2021-07-26) Works well with Vivaldi 4.0.2312.24. Does not work with 4.0.2312.41.