feat: add image zoom to improve image viewing experience #20763

reidliu41 · 2025-07-10T14:58:15Z

Essential Elements of an Effective PR Description Checklist

The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
The test plan, such as providing test command.
The test results, such as pasting the results comparison before and after, or e2e results
(Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.

Purpose

This enables click-to-zoom on images in documentation using medium-zoom.
It helps users view images more clearly and interactively.

Test Plan

Test Result

(Optional) Documentation Update

github-actions · 2025-07-10T14:58:26Z

👋 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 @reidliu41, 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 significant user experience improvement to the documentation by enabling click-to-zoom functionality for images. This feature utilizes the medium-zoom library to provide a smooth and interactive way for users to view detailed diagrams and screenshots, enhancing the overall readability and utility of the documentation.

Highlights

Documentation Enhancement: Implemented a new image zoom feature for documentation images, allowing users to click and enlarge them.
User Experience: Improves the clarity and interactivity for viewing diagrams and screenshots within the documentation, making complex visuals easier to understand.

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 a nice image zoom feature to the documentation using the medium-zoom library. The implementation is clean and simple. I have two suggestions to improve it:

Security: Add Subresource Integrity (SRI) to the external medium-zoom script in mkdocs.yaml to protect against potential CDN compromises.
Robustness: In image_zoom.js, add a check to ensure the mediumZoom function is available before calling it. This will prevent JavaScript errors if the external library fails to load.

These changes will make the new feature more secure and resilient.

gemini-code-assist · 2025-07-10T14:59:35Z

mkdocs.yaml

@@ -128,6 +128,8 @@ extra_javascript:
  - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML
  - mkdocs/javascript/edit_and_feedback.js
  - mkdocs/javascript/slack_and_forum.js
+  - https://cdn.jsdelivr.net/npm/[email protected]/dist/medium-zoom.min.js


Loading JavaScript from a third-party CDN without Subresource Integrity (SRI) poses a security risk. If the CDN were to be compromised, malicious code could be injected into the documentation pages, leading to Cross-Site Scripting (XSS) vulnerabilities.

To mitigate this, you should add an integrity hash and crossorigin attribute for the medium-zoom script. This ensures that the browser will only execute the script if it matches the expected cryptographic hash.

- url: https://cdn.jsdelivr.net/npm/[email protected]/dist/medium-zoom.min.js integrity: sha256-ZgMyR+SN2PSZ9X/dG2wUeC2e3iT3eT5s21iL3g2QyY0= crossorigin: anonymous

gemini-code-assist · 2025-07-10T14:59:35Z

docs/mkdocs/javascript/image_zoom.js

+document$.subscribe(() => {
+  mediumZoom('article img:not(.no-zoom)', {
+    background: 'rgba(0, 0, 0, 0.8)',
+    margin: 24,
+  });
+});


The current implementation assumes mediumZoom is always available. If the external script from the CDN fails to load due to network issues or CDN downtime, this script will throw a ReferenceError, which could break other JavaScript functionality on the page.

To make the code more robust, it's best to check if mediumZoom is defined as a function before calling it.

Suggested change

document$.subscribe(() => {

mediumZoom('article img:not(.no-zoom)', {

background: 'rgba(0, 0, 0, 0.8)',

margin: 24,

});

});

document$.subscribe(() => {

if (typeof mediumZoom === 'function') {

mediumZoom('article img:not(.no-zoom)', {

background: 'rgba(0, 0, 0, 0.8)',

margin: 24,

});

}

});

reidliu41 · 2025-07-10T15:05:41Z

cc @DarkLight1337

DarkLight1337 · 2025-07-10T15:08:11Z

@hmellor can you review this?

hmellor · 2025-07-10T15:28:58Z

Could we use a mkdocs plugin instead of something custom we have to maintain?

https://squidfunk.github.io/mkdocs-material/reference/images/#lightbox

hmellor

Blocking until we decide which solution to go with

reidliu41 · 2025-07-10T21:09:33Z

updated with glightbox

reidliu41 · 2025-07-10T21:18:53Z

https://app.readthedocs.org/projects/vllm/builds/28816171/

reidliu41 · 2025-07-12T15:18:15Z

hi, May I know any concerns about this?

hmellor

LGTM, can you merge from main? There is a different fix for the gguf issue

requirements/docs.txt

Signed-off-by: reidliu41 <[email protected]>

reidliu41 · 2025-07-15T02:01:34Z

hi @DarkLight1337 can you help to merge if you are online? thanks

reidliu41 · 2025-07-15T03:59:46Z

just tested, looks cool..

reidliu41 requested a review from hmellor as a code owner July 10, 2025 14:58

gemini-code-assist bot reviewed Jul 10, 2025

View reviewed changes

mergify bot added the documentation Improvements or additions to documentation label Jul 10, 2025

gemini-code-assist bot reviewed Jul 10, 2025

View reviewed changes

hmellor requested changes Jul 10, 2025

View reviewed changes

reidliu41 force-pushed the add-image-zoom branch from 03f1863 to 90c392f Compare July 10, 2025 21:02

mergify bot added the ci/build label Jul 10, 2025

reidliu41 force-pushed the add-image-zoom branch from 90c392f to 47e3834 Compare July 10, 2025 21:19

hmellor approved these changes Jul 14, 2025

View reviewed changes

requirements/docs.txt Outdated Show resolved Hide resolved

remove gguf

1bc38aa

Signed-off-by: reidliu41 <[email protected]>

reidliu41 force-pushed the add-image-zoom branch from 47e3834 to 1bc38aa Compare July 14, 2025 22:40

vllm-bot merged commit 37e2eca into vllm-project:main Jul 15, 2025
13 checks passed

Uh oh!

feat: add image zoom to improve image viewing experience #20763

feat: add image zoom to improve image viewing experience #20763

Conversation

reidliu41 commented Jul 10, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Essential Elements of an Effective PR Description Checklist

Purpose

Test Plan

Test Result

(Optional) Documentation Update

Uh oh!

github-actions bot commented Jul 10, 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 Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

reidliu41 commented Jul 10, 2025

Uh oh!

DarkLight1337 commented Jul 10, 2025

Uh oh!

hmellor commented Jul 10, 2025

Uh oh!

hmellor left a comment

Choose a reason for hiding this comment

Uh oh!

reidliu41 commented Jul 10, 2025

Uh oh!

reidliu41 commented Jul 10, 2025

Uh oh!

reidliu41 commented Jul 12, 2025

Uh oh!

hmellor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

reidliu41 commented Jul 15, 2025

Uh oh!

Uh oh!

reidliu41 commented Jul 15, 2025

Uh oh!

Uh oh!

reidliu41 commented Jul 10, 2025 •

edited by github-actions bot

Loading