mkdocs-glightbox
MkDocs plugin supports image lightbox with GLightbox.
Decision gist · record as of 2026-08-14
Yes. The plugin is production-stable, actively maintained, has low install friction, carries no known vulnerabilities, and solves a common documentation need (interactive images) with minimal configuration. Install it if you use MkDocs and want lightbox functionality without manual HTML editing.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Low friction install with a single runtime dependency (selectolax).
- The package is actively maintained with a recent release, marked as Production/Stable, and supports current Python versions from 3.8 through 3.14.
License · maintenance · safety
MIT (permissive) — MIT license is permissive, allowing free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.
last release 2025-10-23 (295 days) · last repo commit 2026-03-08 · 188 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 1,432,198 downloads/mo, #3,909 on PyPI
Alternatives
Verify before relying
pip install mkdocs-glightbox
Then add to mkdocs.yml:
plugins:
- glightbox- Whether GLightbox JavaScript file version 3.3.1 is automatically bundled or must be manually added to the site
- Specific behavior when images are already wrapped in anchor tags or are emoji from pymdown-extensions
What it is and what it does
mkdocs-glightbox is a MkDocs plugin that automatically enhances images in your documentation with an interactive lightbox viewer. When you build your site, the plugin scans all image tags and wraps them with the GLightbox JavaScript library, which provides a modal image viewer with touch navigation, zoom, drag controls, and mobile support. The plugin uses selectolax to parse and modify the HTML.
You control the behavior through mkdocs.yml configuration: enable or disable the lightbox globally, skip specific images by CSS class, customize effects and animations, add captions from image alt text, group images into galleries, and toggle features like zoom and dragging. You can also disable the lightbox for entire pages or enable it selectively on pages where it's otherwise disabled, making it flexible for mixed documentation styles.
Use it for
- Add interactive image viewing to technical documentation without modifying individual Markdown files
- Create image galleries in your MkDocs site with grouped navigation and swipe controls
- Automatically caption images using their alt text while keeping Markdown source clean
- Disable lightbox for specific images (logos, icons) while enabling it for screenshots and diagrams
- Support mobile documentation viewers with touch-friendly image navigation and zoom
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The plugin is production-stable, actively maintained, has low install friction, carries no known vulnerabilities, and solves a common documentation need (interactive images) with minimal configuration. Install it if you use MkDocs and want lightbox functionality without manual HTML editing.
Install
mkdocs-glightbox on PyPI
Before you install
Low friction install with a single runtime dependency (selectolax). The package is actively maintained with a recent release, marked as Production/Stable, and supports current Python versions from 3.8 through 3.14.
License in practice
MIT license is permissive, allowing free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.
Quickstart
pip install mkdocs-glightbox
Then add to mkdocs.yml:
plugins:
- glightboxVerify before relying
- Whether GLightbox JavaScript file version 3.3.1 is automatically bundled or must be manually added to the site
- Specific behavior when images are already wrapped in anchor tags or are emoji from pymdown-extensions
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.8 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packageselectolax |
| Maintenance | Actively maintained 295 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 1,432,198 / month, #3,909 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleEnvironment :: Web EnvironmentIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: DocumentationTopic :: Text Processing |
Evidence: mkdocs_glightbox-0.5.2-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs image lightbox plugin”
- mkdocs-glightboxA MkDocs plugin that automatically wraps images in a lightbox viewer…
- mkdocs-drawioA MkDocs plugin that embeds interactive Drawio diagrams directly into…
- sphinxcontrib-imagesA Sphinx extension that replaces standard image directives with…
Give your agent the search over MCP, or paste the wish link into any chat.
More Text Processing packages
A drop-in replacement for Python's standard `re` module that adds advanced regex features like nested sets, fuzzy matching, lookaround in conditionals, and full Unicode case-folding while maintaining backward compatibility.
pyparsing provides a library for building text parsers directly in Python code using composable grammar classes, handling quoted strings, whitespace variation, and embedded comments without regex or lex/yacc.
Install it if you need to parse text or define grammars programmatically.
fonttools manipulates font files in multiple formats (TrueType, OpenType, AFM, Type 1, Mac-specific) and includes TTX, a tool to convert fonts to and from XML text format.
Install it if you need to read, write, or manipulate fonts programmatically or via the TTX command-line tool.
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
RapidFuzz provides fast fuzzy string matching using Levenshtein Distance and related metrics, implemented mostly in C++ with Python bindings for rapid similarity scoring and approximate string matching.
Install it if you need fuzzy string matching; it's a solid replacement for FuzzyWuzzy with better licensing and performance.
tinycss2 parses CSS strings into token and block objects, and generates CSS strings from those objects, following the CSS Syntax Level 3 specification without enforcing specific properties or values.
Install it if your project requires CSS tokenization or syntax manipulation.
See also mkdocs-drawio · mkdocs-panzoom-plugin · mkdocs-video · mkdocs-swagger-ui-tag · mkdocs-material · mkdocs-awesome-pages-plugin · mkdocs-kroki-plugin · mkdocs-print-site-plugin · mdformat-mkdocs · mkdocs-plugin-inline-svg