nvim-orgmode / nvim-orgmode/orgmode
`which-key` integration
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 3.9k
- Forks
- 190
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 7
Description
Does this feature exist in Emacs orgmode core?
N/A
Orgmode link
No response
Feature value
Many Neovim users use which-key for help with remembering keybindings. A plugin like orgmode, with its dozens of mappings, benefits from this a lot.
When I first started using this plugin, was very overwhelmed by the number of keymaps. I thought that I could rely on which-key, but after pressing the org-prefix combination (<leader>o in my config), I was greeted by a large number of +X keymaps labels, which did not help me find my way. I feel that integrating which-key groups would go a very long way towards making the plugin more accessible for new users, which is something (I think) orgmode can improve on.
Orgmode already works well with which-key. However, there is missing support for one of its greatest features, groups. Groups allow us to create a label to describe keymaps that have a common prefix, helping users easily remember which key they need to press next to get to the category they want.
Additional context
For your reference, this is how which-key looks with orgmode on my setup. Kindly note that the +fzf org group is one that I added in my own config; I'm proposing to add a similar label for all of the "nested" keymaps.
I'm unclear whether this belongs in the main repo. It's not an emacs core feature, but it's also not an orgmode plugin, either; rather, an optional integration with a Neovim plugin. Let me know if this would be better suited as a separate plugin.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue does not name files or tests. Start by locating orgmode's existing keymap definitions and current which-key compatibility, then determine how nested mappings should be grouped and whether the integration belongs in this repository. Done means the proposed groups are implemented consistently or the integration is clearly scoped as a separate plugin.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, neovim
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100