You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,6 +59,10 @@ module.exports = {
59
59
// For Docs using Chinese, it is recomended to set:
60
60
// language: ["en", "zh"],
61
61
62
+
// Customize the keyboard shortcut to focus search bar (default is "mod+k"):
63
+
// searchBarShortcutKeymap: "s", // Use 'S' key
64
+
// searchBarShortcutKeymap: "ctrl+shift+f", // Use Ctrl+Shift+F
65
+
62
66
// If you're using `noIndex: true`, set `forceIgnoreNoIndex` to enable local index:
63
67
// forceIgnoreNoIndex: true,
64
68
}),
@@ -92,6 +96,7 @@ module.exports = {
92
96
| ignoreCssSelectors | string \| string[]|`[]`| A list of css selectors to ignore when indexing each page. |
93
97
| searchBarShortcut | boolean |`true`| Whether to enable keyboard shortcut to focus in search bar. |
94
98
| searchBarShortcutHint | boolean |`true`| Whether to show keyboard shortcut hint in search bar. Disable it if you need to hide the hint while shortcut is still enabled. |
99
+
| searchBarShortcutKeymap | string |`"mod+k"`| Custom keyboard shortcut to focus the search bar. Supports formats like: `"s"` for single key, `"ctrl+k"` for key combinations, `"mod+k"` for Command+K (Mac) / Ctrl+K (others) - recommended cross-platform option, `"ctrl+shift+k"` for multiple modifiers. |
95
100
| searchBarPosition |`"auto"`\|`"left"`\|`"right"`|`"auto"`| The side of the navbar the search bar should appear on. By default, it will try to autodetect based on your docusaurus config according to [the docs](https://docusaurus.io/docs/api/themes/configuration#navbar-search). |
96
101
| docsPluginIdForPreferredVersion | string || When you're using multi-instance of docs, set the docs plugin id which you'd like to check the preferred version with, for the search index. |
97
102
| zhUserDict | string || Provide your custom dict for language of zh, [see here](https://github.com/fxsjy/jieba#%E8%BD%BD%E5%85%A5%E8%AF%8D%E5%85%B8)|
0 commit comments