search

jmacdonald / amp

A complete text editor for your terminal.
https://amp.rs
Other
3.67k stars 105 forks source link

List available modes in documentation #254

Open adigitoleo opened 2 years ago

adigitoleo commented 2 years ago

It would be convenient for users to have a list of available modes to help when setting up custom bindings.

From looking at the tree, I think the current modes are:

insert
jump
search
search_insert
select
select_line
search_select
search_select_line
path
confirm

Where confirm mode is the "command mode" like when in a file search prompt. I have successfully used these for directives in my config, but I don't know for sure what all of them imply. Unless new modes are planned, I think it is worth putting these in the docs (also in the offline help).

Thank you for creating the project. I applaud the focus on simplicity. For me, I need to change some of the bindings to accommodate my vim habits, hence this issue.

jmacdonald commented 7 months ago

👋🏼 Hi there! I'm hoping the default keymap callout in the key bindings section of the manual is enough to cover that. It's a pretty convenient method that shows all of the modes and their respective bindings.

adigitoleo commented 7 months ago

Yes, I suppose application::display_default_keymap does show these names as section headers. Perhaps in addition to the indentation, these headers could be highlighted in some way, e.g. with ascii underlines or something. But that's just a nitpick at this point. I'd also mention that method in the offline help if possible (the one that shows up when you press ?).