[Doc] cmd+k #19957

aarnphm · 2025-06-22T21:51:28Z

This PR add supports for focusing search with [cmd|ctrl]+k

Signed-off-by: Aaron Pham [email protected]

Signed-off-by: Aaron Pham <[email protected]>

github-actions · 2025-06-22T21:51:35Z

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

gemini-code-assist

Summary of Changes

Hello @aarnphm, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new keyboard shortcut (cmd+k / ctrl+k) to quickly focus the search input field within the documentation, enhancing user experience and navigation efficiency. It also adds a visual indicator to make this new feature discoverable.

Highlights

New Keyboard Shortcut: I've added support for focusing the search bar in the documentation using the cmd+k (on macOS) or ctrl+k (on Windows/Linux) keyboard shortcut. This improves accessibility and speed for users navigating the documentation.
Visual Hint for Search: To inform users about the new shortcut, I've implemented a visual cue that displays 'cmd+k' next to the search input field when it's not active. This makes the shortcut discoverable.
MkDocs Configuration Update: The new JavaScript file containing the shortcut logic has been integrated into the MkDocs configuration (mkdocs.yaml) to ensure it's loaded and active on the documentation site.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request adds support for focusing the search bar using the Cmd/Ctrl+K keyboard shortcut. To improve the user experience, consider dynamically displaying the correct keyboard shortcut (cmd+k for macOS, ctrl+k for Windows/Linux) in the UI by using a CSS variable and JavaScript to detect the user's OS.

gemini-code-assist · 2025-06-22T21:53:05Z

docs/mkdocs/stylesheets/extra.css

+  font-size: .8rem;
+  border: .05rem solid var(--md-default-bg-color--lighter);
+  border-radius: .1rem;
+  content: "cmd+k";


Consider using a CSS variable for the content property to dynamically display the correct keyboard shortcut based on the user's OS. This avoids hardcoding cmd+k which is specific to macOS. The JavaScript can then set the appropriate value for the variable based on the user's platform.

Suggested change

content: "cmd+k";

content: var(--md-search-shortcut);

docs/mkdocs/javascript/shortcuts.js

Signed-off-by: Aaron Pham <[email protected]>

DarkLight1337 · 2025-06-23T02:07:31Z

The shortcut doesn't seem to work as Ctrl+K focuses on the browser's search bar instead.

aarnphm · 2025-06-23T08:35:05Z

yeah i realized.

docs/mkdocs/javascript/shortcuts.js

Signed-off-by: Aaron Pham <[email protected]>

DarkLight1337

Ctrl+K still doesn't work on my end (I'm on Windows). I also tried Alt+K and it doesn't work either

reidliu41 · 2025-06-24T03:52:18Z

docs/mkdocs/javascript/shortcuts.js

+  if (event.key === '/') {
+    // we actually don't want to bind this key on docs given that it uses builtin mkdocs search.
+    event.preventDefault();
+  } elif ((event.altKey || event.metaKey) && event.key === 'k') {


seems use alt + k, @DarkLight1337

aarnphm · 2025-06-24T08:19:15Z

Can u try force refresh all cache?

DarkLight1337 · 2025-06-24T08:33:22Z

Yeah, I tried that already

Signed-off-by: Aaron Pham <[email protected]>

aarnphm · 2025-06-24T08:45:47Z

Ok, I think it might be because of the css haha

DarkLight1337 · 2025-06-24T09:04:37Z

Still doesn't work. Btw, I think the keyboard shortcut might be a bit redundant because simply typing anything on the page opens the search bar...

Signed-off-by: Aaron Pham <[email protected]>

aarnphm · 2025-06-24T21:40:21Z

I don't have a strong opinion on this.

DarkLight1337 · 2025-06-25T02:22:52Z

Alt+K still doesn't work

aarnphm · 2025-06-25T04:38:42Z

ah I'm just going to close this PR for now.

reidliu41 · 2025-06-25T04:48:16Z

docs/mkdocs/javascript/shortcuts.js

@@ -0,0 +1,13 @@
+document.addEventListener('keydown', function (event) {
+  if (event.key.lower() === '/') {


should be toLowerCase()

reidliu41 · 2025-06-25T04:48:40Z

docs/mkdocs/javascript/shortcuts.js

+  if (event.key.lower() === '/') {
+    // we actually don't want to bind this key on docs given that it uses builtin mkdocs search.
+    event.preventDefault();
+  } else if ((event.altKey || event.metaKey) && event.key.lower() === 'k') {


should be toLowerCase()
@DarkLight1337 i test work in mac and or win

feat(docs): cmd+k

cda2c54

Signed-off-by: Aaron Pham <[email protected]>

aarnphm requested a review from hmellor as a code owner June 22, 2025 21:51

gemini-code-assist bot reviewed Jun 22, 2025

View reviewed changes

mergify bot added the documentation Improvements or additions to documentation label Jun 22, 2025

gemini-code-assist bot reviewed Jun 22, 2025

View reviewed changes

aarnphm added 2 commits June 22, 2025 18:28

chore: update theme and bind correct item

595cd56

Signed-off-by: Aaron Pham <[email protected]>

fix: listening to events

fe5444f

Signed-off-by: Aaron Pham <[email protected]>

reidliu41 reviewed Jun 23, 2025

View reviewed changes

docs/mkdocs/javascript/shortcuts.js Outdated Show resolved Hide resolved

aarnphm added 2 commits June 23, 2025 12:14

chore: use raw addEventListener

5b2bbc5

Signed-off-by: Aaron Pham <[email protected]>

chore: add placeholder

4edc7ae

Signed-off-by: Aaron Pham <[email protected]>

aarnphm requested a review from DarkLight1337 June 23, 2025 20:55

DarkLight1337 reviewed Jun 24, 2025

View reviewed changes

reidliu41 reviewed Jun 24, 2025

View reviewed changes

chore: remove styles

f31db3a

Signed-off-by: Aaron Pham <[email protected]>

chore: update js

6d2f19c

Signed-off-by: Aaron Pham <[email protected]>

aarnphm closed this Jun 25, 2025

aarnphm deleted the chore/cmd-k branch June 25, 2025 04:38

reidliu41 reviewed Jun 25, 2025

View reviewed changes

		@@ -0,0 +1,13 @@
		document.addEventListener('keydown', function (event) {
		if (event.key.lower() === '/') {

Uh oh!

[Doc] cmd+k #19957

[Doc] cmd+k #19957

Conversation

aarnphm commented Jun 22, 2025

Uh oh!

github-actions bot commented Jun 22, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jun 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DarkLight1337 commented Jun 23, 2025

Uh oh!

aarnphm commented Jun 23, 2025

Uh oh!

Uh oh!

DarkLight1337 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reidliu41 Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

aarnphm commented Jun 24, 2025

Uh oh!

DarkLight1337 commented Jun 24, 2025

Uh oh!

aarnphm commented Jun 24, 2025

Uh oh!

DarkLight1337 commented Jun 24, 2025

Uh oh!

aarnphm commented Jun 24, 2025

Uh oh!

DarkLight1337 commented Jun 25, 2025

Uh oh!

aarnphm commented Jun 25, 2025

Uh oh!

reidliu41 Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

reidliu41 Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DarkLight1337 left a comment •

edited

Loading