☰

Overleaf Editor Custom VIM Keybindings (Code Mirror v6)

Configure a list of shortcuts for Vim-mode + user-defined :commands for toggling panels on Overleaf.

À partir de 2023-03-02. Voir la dernière version.

Auteur
llinfeng
Évaluations
0 0 0
Version
0.0.2
Créer
2023-03-02
Mis à jour
2023-03-02
Taille
4,2 ko
Licence
MIT
S'applique à

This is a work-in-progress script that aims at restoring the full functionality of the old Custom Vim Keybindings for Overleaf. Per their recent update, the legacy editor (Ace) is no longer available for some users (myself included), replaced by Code Mirror (v6?). Reassuringly, both Ace and Code Mirror use the same VIM Mode API, documented here.

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>, imap jk <esc> and imap <c-]> <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.

And, those that need extra work, include:

  • :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.

Troubleshooting

  1. If the PDF fails to compile, TogglePDF won't work as intended. (This impacts the :pdf command and the <leader>o mapping.)