Navigation - help with keyboard shortcuts

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

Nobody has claimed this yet.

Assessment

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

Research direction

No file or test is named in the issue. Start by locating the reader navigation and existing keyboard-shortcut handling, then trace how navigation-bar controls are rendered. Done means readers can open an overlay with the available shortcuts, initially using fixed text, with local configuration support as the follow-up direction.

Written by the indexing model from the issue text.

Description

C-enhancement
Problem

In anticipation of allowing book authors do define / enable more keyboard shortcuts and even without that it would be a good idea to make
it easy for readers to find out the available keyboard shortcuts. AFAIK the button to activate this is usually ?, though we might want to also add a help icon to the menu-bar.

See also #1408

Proposed Solution

Let's start with a simple overlay with some fixed text and then make it based on the local configuration.

Notes

No response

Dominant language
Rust
Stars
22.2k
Forks
1.9k
Avg merge
2d 21h
Merged PRs (30d)
12

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.

More from rust-lang/mdBook

All issues in rust-lang/mdBook

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.