Repository navigation
Open search with Cmd+K / Ctrl+K - #4852
Closed
Sushants-Git wants to merge 1 commit into
Closed
Sushants-Git wants to merge 1 commit into
Sushants-Git wants to merge 1 commit into
Conversation
mdBook's built-in search is only reachable with S or /, which many readers don't know about. Cmd+K (macOS) / Ctrl+K (elsewhere) is the shortcut most documentation sites use for search, so bind it to the existing search bar and mention it in the placeholder.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
mdBook's built-in search is currently only reachable with
Sor/, which many readers never discover. Cmd+K (macOS) / Ctrl+K (elsewhere) is the shortcut most documentation sites use for search, so this binds it to the existing search bar.What it does
cmdk-search.js(loaded viaadditional-js, next toferris.js).aria-keyshortcuts.It reuses mdBook's existing search (index, ranking, keyboard navigation), so there's no new search UI or dependency. mdBook's own key handler ignores modified keys, so the existing
S//shortcuts are unaffected.Testing
Built with mdBook 0.5.1 (the CI version) and checked in headless Chromium: Cmd+K opens and focuses the search bar, typing returns results, and pressing Cmd+K again while open refocuses the input.
dprint checkpasses.