rust-lang / rust-lang/mdBook

hjkl navigation

Open
#2,936 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

One has to leave the home row to navigate a page using the keyboard

Proposed Solution

Implement the following keybindings:

  1. h - go to the previous page
  2. j - scroll the page a bit down similar to pressing the down arrow
  3. k - scroll the page a bit up similar pressing the up arrow
  4. l - go to the next page

Also consider these keybindings:

  1. d - scroll the page down similar to pressing the PgDown button
  2. u - scroll the page up similar to pressing the PgUp button
Notes

I might implement it myself

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or existing entry points, so first locate where page navigation and keyboard input are handled. Done means the specified h, j, k, and l bindings work as described, with d and u considered separately.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.