Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: Keyboard bindings #2279

Merged
merged 29 commits into from
Dec 5, 2023
Merged

feat: Keyboard bindings #2279

merged 29 commits into from
Dec 5, 2023

Conversation

jhildenbiddle
Copy link
Member

@jhildenbiddle jhildenbiddle commented Oct 17, 2023 •
edited
Loading

Summary

  • Add new keyBindings configuration option
  • Add default docsify bindings
    • \ Toggle sidebar menu. Includes hover/focus hints via title/aria-keyshortcuts attributes.
    • / Focus on search field (also supports Cmd / Ctrl + k). Includes visual and hover/focus hints via title/aria-keyshortcuts attributes. This is a standard shortcut as seen on competitors like Docusaurus, GitBook, Starlight, and VitePress.
  • Add keyBindings documentation (see preview link below)
  • Add e2e tests

Related issue, if any:

#2278

What kind of change does this PR introduce?

Feature

For any code change

  • Related documentation has been updated, if needed
  • Related tests have been added or updated, if needed

Does this PR introduce a breaking change?

No

Tested in the following browsers:

  • Chrome
  • Firefox
  • Safari
  • Edge

@vercel
Copy link

vercel bot commented Oct 17, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docsify-preview ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 30, 2023 6:39pm

@jhildenbiddle jhildenbiddle changed the title Feature: keyboard bindings Feat: keyboard bindings Oct 17, 2023
@jhildenbiddle jhildenbiddle changed the title Feat: keyboard bindings Feat: Keyboard bindings Oct 17, 2023
@jhildenbiddle jhildenbiddle mentioned this pull request Oct 18, 2023
Closed
@jhildenbiddle jhildenbiddle mentioned this pull request Oct 29, 2023
Merged
5 tasks
@jhildenbiddle jhildenbiddle requested a review from a team November 2, 2023 16:10
@jhildenbiddle jhildenbiddle marked this pull request as ready for review November 2, 2023 21:54
@jhildenbiddle jhildenbiddle linked an issue Nov 16, 2023 that may be closed by this pull request
Feature: navigation keyboard bindings/shortcuts #2278
Closed
@jhildenbiddle
Merge branch 'develop' into 2278-keybindings
4461aca 
# Conflicts:
#	src/core/event/index.js
@jhildenbiddle
Merge branch 'develop' into 2278-keybindings
4c574fe 
# Conflicts:
#	src/core/render/tpl.js
Koooooo-7
Koooooo-7 approved these changes Dec 1, 2023
View reviewed changes
Copy link
Member

@Koooooo-7 Koooooo-7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and thx a lot for your meticulous explanation and works !

@jhildenbiddle
Copy link
Member Author

@sy-records? @trusktr?

@sy-records sy-records merged commit cf61192 into develop Dec 5, 2023
9 checks passed
@sy-records sy-records changed the title Feat: Keyboard bindings feat: Keyboard bindings Dec 5, 2023
@sy-records sy-records deleted the 2278-keybindings branch December 5, 2023 00:09
@jhildenbiddle jhildenbiddle mentioned this pull request Jun 16, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sy-records sy-records sy-records approved these changes

@Koooooo-7 Koooooo-7 Koooooo-7 approved these changes

@trusktr trusktr Awaiting requested review from trusktr

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Feature: navigation keyboard bindings/shortcuts
3 participants
@jhildenbiddle @Koooooo-7 @sy-records