Skip to content

Add Ctrl+K / ⌘-K support #2937

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+17 −2
Open

Add Ctrl+K / ⌘-K support #2937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b47c7a9
Add Ctrl+K (or ⌘-K if on macOS) to bring up the search bar
trolleyman Nov 16, 2025
74d3d4e
Add documentation for Ctrl/⌘+K
trolleyman Nov 16, 2025
ee873ec
Fix eslint
trolleyman Nov 16, 2025
f230d93
Add Ctrl+K to the docs
trolleyman Nov 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions crates/mdbook-html/front-end/searcher/searcher.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,16 @@ window.search = window.search || {};

// Eventhandler for keyevents on `document`
function globalKeyHandler(e) {
const metaIsCtrl = navigator.platform &&
(navigator.platform.startsWith('Mac') || navigator.platform === 'iPhone');
if ((metaIsCtrl ? e.metaKey : e.ctrlKey) && e.key === 'k') {
e.preventDefault();
showSearch(true);
window.scrollTo(0, 0);
searchbar.select();
return;
}

if (e.altKey ||
e.ctrlKey ||
e.metaKey ||
Expand Down
7 changes: 6 additions & 1 deletion crates/mdbook-html/front-end/templates/index.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,12 @@
<div>
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
{{#if search_enabled}}
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
<p>Press <kbd>S</kbd>, <kbd>/</kbd>, or <kbd id="kbd-ctrl-cmd">Ctrl</kbd>+<kbd>K</kbd> to search in the book</p>
<script>
if (navigator.platform && (navigator.platform.startsWith("Mac") || navigator.platform === "iPhone")) {
document.getElementById("kbd-ctrl-cmd").innerText = "⌘";
}
</script>
{{/if}}
<p>Press <kbd>?</kbd> to show this help</p>
<p>Press <kbd>Esc</kbd> to hide this help</p>
Expand Down
2 changes: 1 addition & 1 deletion guide/src/guide/reading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Tapping the menu bar will scroll the page to the top.
## Search

Each book has a built-in search system.
Pressing the search icon <i class="fas fa-magnifying-glass"></i> in the menu bar, or pressing the <kbd>/</kbd> or <kbd>S</kbd> key on the keyboard will open an input box for entering search terms.
Pressing the search icon <i class="fas fa-magnifying-glass"></i> in the menu bar, <kbd>Ctrl</kbd>+<kbd>K</kbd> (<kbd>⌘</kbd>+<kbd>K</kbd> on macOS), or pressing the <kbd>/</kbd> or <kbd>S</kbd> key on the keyboard will open an input box for entering search terms.
Typing some terms will show matching chapters and sections in real time.

Clicking any of the results will jump to that section.
Expand Down