raw-bacon / vi-xournalpp

A small plugin for Xournal++ version 1.1.x and 1.2.x with vi-like modes
42 stars 5 forks source link

Remove outdated chearsheet and provide markdown version #24

Open PatrickMassot opened 5 days ago

PatrickMassot commented 5 days ago

Thank you very much for this plugin.

I think a serious obstacle for new users is that the documentation does not mention the actual keybindings. There is cheatsheet.xopp but it is outdated, hence rather confusing. Of course keybindings.lua is pretty readable, but still a bit too verbose.

Maintaining cheatsheet.xopp is probably too tedious. It would be great to auto-generate it, but this would require some work. What I did for myself was to generate a markdown file from keybings.lua. The result is not great, in particular because the configuration table is not ordered, so for instance thickness options are not shown in order. But it is still useful to me, so I thought I would share it.

Feel free to ignore or do it better (I never write Lua outside of my neovim config, I think this is by far the longest Lua program I ever wrote).