Skip to content

keybindings should be discoverable #697

@aronatkins

Description

@aronatkins

Keyboard shortcuts are not discoverable by users. The ones I have uncovered:

  • f opens the search input with an active cursor
  • <left> and <right> navigate to the head of the next/previous chapter
  • <up> and <down> navigate to the next/previous search match (assuming search is active)

I don't know the best way to educate users. Sites like GitHub and GMail offer a ? shortcut, but then there is the issue of having users discover that shortcut.

Things like f are documented in the bookdown book, but that is educating the book authors, not the readers. https://bookdown.org/yihui/bookdown/html.html#gitbook-style

Features in the bookdown GitBook style should be more self-discoverable by the reader. We should not leave it to each book author to create that logic.

This issue appears to be present in bookdown 0.1 to 0.9. The RStudio Connect Admin Guide is an example using a SHA close to 0.7.7 and does not appear to have discoverable keyboard shortcuts. https://docs.rstudio.com/connect/admin/

By filing an issue to this repo, I promise that

  • I have fully read the issue guide at https://yihui.name/issue/.
  • I have provided the necessary information about my issue.
    • If I'm asking a question, I have already asked it on Stack Overflow or RStudio Community, waited for at least 24 hours, and included a link to my question there.
    • If I'm filing a bug report, I have included a minimal, self-contained, and reproducible example, and have also included xfun::session_info('bookdown'). I have upgraded all my packages to their latest versions (e.g., R, RStudio, and R packages), and also tried the development version: remotes::install_github('rstudio/bookdown').
    • If I have posted the same issue elsewhere, I have also mentioned it in this issue.
  • I have learned the Github Markdown syntax, and formatted my issue correctly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions