Skip to content

Add vi movement keys for navigating rust documentation #44964

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

Open
cherryman opened this issue Oct 1, 2017 · 9 comments
Open

Add vi movement keys for navigating rust documentation #44964

cherryman opened this issue Oct 1, 2017 · 9 comments
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. P-low Low priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@cherryman
Copy link

cherryman commented Oct 1, 2017

Adding vi movements keys would make it much faster to navigate the documentation while programming, since it would avoid having to resort to the mouse or arrow keys as frequently. Moving hands around can be annoying and is the reason many optimise their setups to avoid doing so.

@est31
Copy link
Member

est31 commented Oct 1, 2017

It will help the vim fans and it would confuse everyone else.

@Javyre
Copy link

Javyre commented Oct 1, 2017

GitHub has some vi inspired shortcuts and I don't see people complaining or being confused.

https://help.github.com/articles/using-keyboard-shortcuts/

@Javyre
Copy link

Javyre commented Oct 1, 2017

Another example: Godoc.org
image

@steveklabnik steveklabnik added C-enhancement Category: An issue proposing an enhancement or a PR with one. I-nominated A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Oct 2, 2017
@steveklabnik
Copy link
Member

Nominating to talk about this at a future doc meeting.

@GuillaumeGomez
Copy link
Member

... Why not? ... (I'm super doubtful about the usefulness of this feature but I like useless things so why not haha.)

@steveklabnik
Copy link
Member

We talked about this at the docs team meeting today. The outcome was, basically, everyone is uncomfortable with framing this as "vim compatible", in the sense that we wouldn't ever be fully compatible with vim. But we already have some keyboard shortcuts, and adding more isn't a terrible idea. If we can come up with a specific list of ones, we can discuss those, but defining the scope here first is important.

@cherryman
Copy link
Author

The goal here is to allow for faster and smoother movement in documentation, not necessarily to be "vim compatible"

My main suggestion is to add hjkl for moving through search results and methods, although this would require the search box to be de-selected after searches. I don't think is too much of a concern since it can easily be selected using "s", but that's just me.

If anyone has any suggestions for vi-related keybinds that would make navigation easier, it would be appreciated. My goal here to remove the hassle involved in moving the arm between the mouse and the keyboard, so if there are keybinds unrelated to vi that would allow that, they would be perfectly fine.

@Javyre
Copy link

Javyre commented Oct 31, 2017

thought it would be relevant to mention here that google also implements vim-like bindings
https://support.google.com/drive/answer/2563044?hl=en

maybe we could draw some inspiration from hese binds?

@steveklabnik steveklabnik added the P-low Low priority label Oct 31, 2017
@QuietMisdreavus QuietMisdreavus added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. and removed T-rustdoc labels May 15, 2018
@PramodBisht
Copy link
Contributor

PramodBisht commented Jun 10, 2018

Or we can also use VI based add-ons available for browsers.

@steveklabnik steveklabnik removed the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Jan 10, 2019
@jonas-schievink jonas-schievink added C-feature-request Category: A feature request, i.e: not implemented / a PR. and removed C-enhancement Category: An issue proposing an enhancement or a PR with one. labels Feb 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. P-low Low priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

9 participants