Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

which-key integration #876

Open
ficcdaf opened this issue Jan 30, 2025 · 1 comment
Open

which-key integration #876

ficcdaf opened this issue Jan 30, 2025 · 1 comment
Labels
enhancement Enhancement, not necessarily available in emacs

Comments

@ficcdaf
Copy link

ficcdaf commented Jan 30, 2025

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.

Image

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.

@ficcdaf ficcdaf added the enhancement Enhancement, not necessarily available in emacs label Jan 30, 2025
@kristijanhusak
Copy link
Member

I use which-key, but only with default settings. I know that desc on the mapping shows in which key, but I don't know anything about the groups. How is group added?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement, not necessarily available in emacs
Projects
None yet
Development

No branches or pull requests

2 participants