Documentation - Keybindings Table

SidOfc / mkdx

A vim plugin that adds some nice extra's for working with markdown documents

https://www.vim.org/scripts/script.php?script_id=5620

MIT License

484 stars 13 forks source link

Documentation - Keybindings Table #153

Closed theduke closed 3 years ago

theduke commented 3 years ago

The functionality and documentation of this plugin is truly outstanding! Great job.

The README could really use a short overview of the available keybindings, though.

Something like:

Key	Action
Deadlink detection	`<Prefix>L`
...	...

SidOfc commented 3 years ago

Hello @theduke, I believe this is what you are looking for: https://github.com/SidOfc/mkdx#mappings. The table of contents in the README can be expanded, so you may have skipped over it :)

And last but not least, thank you for the compliments, enjoy the plugin :+1:

theduke commented 3 years ago

Yes indeed, exactly what I wanted.

I would suggest moving the mapping table before the settings section though, to make it a bit more discoverable.

SidOfc commented 3 years ago

Glad the issue is solved, I appreciate the suggestion to move the mapping table but I think I will keep it where it is right now for multiple reasons:

Existing users already know the current position
The word "mapping" is a common term in the Vim community, a lot of people will ctrl+f it if they don't see it
The Table of Contents is placed very high on the page, if people ctrl+f "table" they will land there instantly

This does not mean however, that it will never happen. When more people come along with support for similar opinions I will definitely reconsider.