Skip to content

Conversation

jhildenbiddle
Copy link
Member

@jhildenbiddle jhildenbiddle commented Oct 17, 2023

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

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
# Conflicts: #	src/core/event/index.js
# Conflicts: #	src/core/render/tpl.js
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 sy-records merged commit cf61192 into develop Dec 5, 2023
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants