fix: Enable GLightbox for Image Zoom in Devant Documentation#172
fix: Enable GLightbox for Image Zoom in Devant Documentation#172Tharindu-Senanayake12 wants to merge 1 commit intowso2:mainfrom
Conversation
WalkthroughThe change enables the glightbox plugin in the MkDocs configuration file to restore image lightbox functionality in the documentation. This plugin was previously listed in issue but not activated in the plugins section of the configuration. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/mkdocs.yml`:
- Line 188: The mkdocs-glightbox dependency is pinned to an outdated version
(0.3.4); update the pinned version in requirements.txt to the latest stable
release (0.5.2) so the plugin referenced in mkdocs.yml (mkdocs-glightbox) uses
the newer package; open requirements.txt, find the mkdocs-glightbox entry and
change its version specifier to 0.5.2 (or a compatible range like >=0.5.2,<0.6)
and run dependency install/tests to verify nothing breaks.
| - search: | ||
| lang: ['en'] | ||
| - open-in-new-tab | ||
| - glightbox |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
What is the latest version of mkdocs-glightbox plugin?
💡 Result:
The latest released version of the mkdocs-glightbox plugin is 0.5.2 (released October 23, 2025) on PyPI. [1]
Consider updating mkdocs-glightbox to the latest version.
The plugin addition is correctly implemented with proper syntax and placement. However, the pinned version 0.3.4 is outdated—the latest available version is 0.5.2 (released October 2025). Consider updating mkdocs-glightbox in requirements.txt to benefit from recent improvements and maintenance.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/mkdocs.yml` at line 188, The mkdocs-glightbox dependency is pinned to an
outdated version (0.3.4); update the pinned version in requirements.txt to the
latest stable release (0.5.2) so the plugin referenced in mkdocs.yml
(mkdocs-glightbox) uses the newer package; open requirements.txt, find the
mkdocs-glightbox entry and change its version specifier to 0.5.2 (or a
compatible range like >=0.5.2,<0.6) and run dependency install/tests to verify
nothing breaks.
1 participant
Purpose
Resolves #171
Images within the Devant documentation are currently static and do not open in a zoomed overlay when clicked, making it difficult to view detailed diagrams or screenshots.
Goals
Enable the GLightbox plugin to restore image zooming and lightbox overlay functionality across the documentation site, improving readability and user experience.
Approach
Added the
glightboxplugin under thepluginslist in themkdocs.ymlconfiguration file. This instructs the Material for MkDocs theme to initialize the lightbox script for all standard Markdown images.User Stories
Release Note
Fixed an issue where documentation images were not opening in a lightbox overlay by enabling the GLightbox MkDocs plugin.
Documentation
N/A - This PR itself is a fix applied to the documentation site's infrastructure and does not change the core product documentation content.
Training
N/A
Certification
N/A - This is a UI fix for the documentation website and does not impact certification exams.
Marketing
N/A
Automation Tests
Unit Tests
N/A - Documentation configuration change.
Integration Tests
N/A - Documentation configuration change.
Security Checks
Samples
N/A
Related PRs
N/A
Migrations (if applicable)
N/A
Test Environment
Tested locally using
mkdocs serveto verify image click behavior.Learning
Researched the Material for MkDocs theme documentation regarding image zoom support and identified that the native
glightboxplugin needed to be explicitly declared in the configuration to function properly.Summary by CodeRabbit