mattmc3/neovim-cheatsheet

Google Sheets docs for neovim/vim cheatsheets and tutorials supporting multiple alternative keyboard layouts

TLDR;

Click here to open the Google Sheets neovim cheatsheet. Feel free to copy it to your Google Drive and modify it however you choose. There's also many other non-QWERTY layouts available for users or Colemak, Dvorak, and more. You can find more in the links below.

Neovim Cheat Sheet

A modern and customizable take on the excellent viemu cheat sheet, supporting QWERTY as well as alternative keyboard layouts such as Colemak and Dvorak.

Project genesis

When I was first learning neovim, having a cheatsheet was incredibly helpful. There are many excellent ones online, but most of them were distributed as image files. That was fine if you use a QWERTY keyboard and don't want to customize your vimrc. But I use an alternative keyboard, Colemak. And I prefer to nnoremap some of my normal mode keys. I wanted an easy to manipulate the cheat sheet where I could first rearrange the keys to match my keyboard layout, and then test out other arrangements of keys to match my desired nnoremaps. I figured Google Sheets would be a simple way to experiment, and thus this project was born.

Code

There's a pretty rudimentary apps-script for generating the basic template included in this repo, but that's not required. It's something I used to bootstrap these Google Sheets.

Cheat Sheets and Tutorials

Here is a list of the neovim cheat sheets and tutorials. These are designed to be easily printed to standard letter paper, exported to PDF, or copied into your personal Google Drive and manipulated however you see fit.

• Cheat Sheets:

  • Standard QWERTY
  • Common alternative layouts:
    • Colemak
    • Colemak (Mod-DH)
    • Dvorak
    • Programmer Dvorak
  • Other layouts:
    • Carpalx QFMLWY
    • Norman
    • Workman
    • Minimak 4
    • Minimak 8
    • Minimak 12

• Tutorials:

  • Standard QWERTY
  • Colemak
  • Colemak (Mod-DH with ANSI keyboard)
  • Colemak (Mod-DH with ISO keyboard)
  • Dvorak

• nnoremap examples:

  • Colemak arrow remapping using langmap
  • Colemak J-->E & N-->K swap
  • Colemak all mnemonic NEST remapping

Contributing

This project is designed in such a way that you are free to copy these Google Docs to your personal Google Drive and manipulate them however you wish (see Creative Commons Attribution license here). If you find a spelling, grammar, formatting, or accuracy issue, please submit a GitHub Issue and I will happily correct those kinds of errors in the master documents.

If there's a layout you wish were included, you are welcome to submit a GitHub Issue, however I cannot support every layout. Depending on the layout's viability and usefulness to a broad audience, I will likely recommend that you maintain your own document.

Please do not submit your personal neovim nnoremaps. I included a few Colemak samples just to whet your appetite to show how you can make your own, but they are not a contributable part of this project.

Note that fidelity in exporting to Excel is not in scope for this project. Please do not submit issues related to Excel.