Visually display customizable search keyboard shortcut to user
vhscom opened this issue · comments
Feature request
Problem or desire
#2278 added keyboard shortcuts for search and, I believe, collapsing the sidebar. In order to make it easier for users to discover keyboard shortcuts associated with search I'd like the ability to display a kbd key combo so users can quickly find it like:
Proposal
Add and style a presentational keyboard shortcut key for sighted users. If there's more than one keyboard shortcut for search, allow the user to pick one keyboard option to display to the user.
Implementation
Something like:
<kbd class="keyboard-shortcut"><span class="keyboard-shortcut-keys">⌘</span>K</kbd>
Hi @vhscom.
A keyboard shortcut icon was added in #2278 (issue) / #2279 (PR). It currently shows a forward slash. You can review this on our develop branch preview. This feature will not be available publicly until Docsify v5 is released.
<kbd title="Press / to search">/</kbd>FYI, both Command+K and Control+K work as well as search shortcuts. I opted to display / because it is a single keystroke and universal across operating systems. Conditionally displaying ⌘ K for macOS or ⌃ K for other operating systems require OS detection which I was hoping to avoid. That said, I'm not opposed to making the switch since Command/Control+K is more common.