blueswen / mkdocs-glightbox Goto Github PK
View Code? Open in Web Editor NEWA MkDocs plugin supports image lightbox (zoom effect) with GLightbox.
Home Page: https://blueswen.github.io/mkdocs-glightbox/
License: MIT License
A MkDocs plugin supports image lightbox (zoom effect) with GLightbox.
Home Page: https://blueswen.github.io/mkdocs-glightbox/
License: MIT License
I cannot install the plugin with the pip install mkdocs-glightbox
command as suggested in the README. It appears that pip
only displays a warning and the install was successful, but then the plugin is not in the installed package list, and mkdocs
cannot find it:
The workaround is to install the plugin with the below command, but it took a while for me to figure this out:
pip install --use-pep517 mkdocs-glightbox
I'm using the following versions:
Hi,
When I active glightbox, don't have a search, please help me how to fix
Thanks.
The caption shown in the lightbox seems to inherit the currently selected color scheme. So when the light theme (aka default theme) is selected, the lightbox shows a bright black-on-white caption box which can look unpleasant and distract from the image (esp. when the image is low key). Since the lightbox itself always has a black background, it would make a lot of sense to force the lightbox caption to always have white(ish) text on black background, regardless of currently selected color theme. Is there a way to do so, without modifying the source code?
https://biati-digital.github.io/glightbox/#examples has "Iframes and Inline Elements" examples which could be convenient, e.g. for Slideshows.
Is it possible to write Markdown with mkdocs-glightbox which would be rendered as GLightbox inline elements?
Embedding HTML in Markdown files would be fine too.
This is a very cool plugin!
There is only one problem I am facing, when a page uses the #only-light
or #only-dark
feature of Mkdocs, the gallery has blank images (for the images which are hidden based on the theme).
For example, if you include the following markdown on a page:
![Image title](https://dummyimage.com/600x400/f5f5f5/aaaaaa#only-light)
![Image title](https://dummyimage.com/600x400/21222c/d5d7e2#only-dark)
If you are currently in light-mode, the gallery will contain 2 images, with the dark-mode one showing as blank.
Hello,
As far as I can see, you can switch between all images on a site, when glightbox is activated.
When you look into https://biati-digital.github.io/glightbox/, then you will see that each gallery have a predefined number of images.
I do not know how hard it is to implement such a detail, but I think it would be a great extension.
Anyway thank you for this plug-in great work!
when build mkdocs get ERROR - Error reading page 'index.md': 'NoneType' object has no attribute 'group'
(v0.4.3)
but in v0.3.2 all good
I want to skip custom img
tag.
https://github.com/blueswen/mkdocs-glightbox/blob/main/mkdocs_glightbox/plugin.py#L71-L73
Im using material for mkdocs version 9.1.11 with your plugin, and a large image (for example, 3071 x 1896; 150dpi; 32bit; png) doesn't work well with zoom. On clicking the zoom icon, the picture isn't enlarged. Instead it moves to the left. Sometimes it moves beyond the screen.
I tested with versions 0.2.1, 0.3.0 and the latest, and it only works as it should (zoom icon indeed blows up the image in the browser) in 0.2.1.
Is there an extra configuration option to be set which I am missing since 0.3.0 or is it a bug?
Tested in firefox and chrome.
Hi,
thank you very much for this plugin.
Is there a way to set glightbox-manual: true
globally, without the need to include it on every page in the meta?
I would like it always off, and activate it by inserting { .on-glb }
where needed.
Thank you
Hello there
Sorry I’m not able to make the configuration parameters work, neither the effect on hover is working. Did I do something wrong? The plugin is working perfectly but nothing changes with or without the config parameters. I tried to change the effect
in theplugins/glighbox
section but on hover there is no effect, I tried to modify the slide_effect
too but same result.
# Extensions
markdown_extensions:
- abbr
- admonition # Block elements
- pymdownx.details # Collapsible call-outs
- pymdownx.superfences # Nested elements
- pymdownx.mark # Hihlighting text
- attr_list # To add buttons
- md_in_html # To add html in markdown (centred images)
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
# Plugins
plugins:
- search
- markdownextradata
- awesome-pages
- glightbox:
touchNavigation: true
loop: true
effect: zoom
slide_effect: fade
width: 100%
height: auto
zoomable: false
draggable: true
auto_caption: false
caption_position: bottom
background: white
shadow: true
manual: false
# css
extra_css:
- assets/stylesheets/extra.css
# javascript
extra_javascript:
- assets/javascripts/extra.
…
Thanks for the awesome gallery!
As far as I can see, the plugin parses each page of documentation that increase docs build time twice. Is it possible to optimize the plugin work?
Usually, mkdocs built-in plugins use regular expressions to match the specific subsections of documents and then only parse those identified fragments. This is also why the privacy and optimize plugins are very fast, albeit they inspect and alter the HTML output.
Hi,
first, thanks for your plugin! 👍
When using mkdocs-material with the emoji feature, for example by typing:
Hi :man_raising_hand:
It is also picked up by the lightbox and shown inside the loop, which is quite destroying the user experience.
Is there a way to exclude them?
With this update I get "AttributeError: 'NoneType' object has no attribute 'group'" in my deploy to Github Pages
with this I get the caption when the image is clicked. Dont get gallery attribute under the picture
![Test](images/sometest.jpeg){data-gallery="taipei"}
should it just show up as in the examples ?
Hello,
I'm using neoteroi cards and the glightbox plugin conflicts with the imgs.
Maybe it's currently possible to ignore these imgs but I am not having much success. I think it's because the neoteroi plugin does not allow imgs to have classes bound to them via the input object mechanism
I tried enabling
- glightbox:
skip_classes:
- skip
and applying the skip class to the actual card element to be ignored by glightbox, but glightbox only adheres to img, as it should.
I guess what I'm asking is, is it currently possible to ignore classes of things other than imgs? Right now, I can only get things to work by disabling glightbox on the page completely, which i really don't want to do as it's an awesome plugin.
Hello,
This is a question but I can't myself label it as so.
I was wondering if the description is shown when the lightbox is open?
With the following
<figure class="image">
<img src="url" alt="description">
<figcaption>description</figcaption>
</figure>
Would (Could) the description be shown in full screen view?
Cheers,
M
Hey, would it feasible to support transparency in in images (e.g on PNGs and SVGs)? Thank you!
Hello,
Nice plugin here, thanks!
Would you consider adding support for color theme and dynamic change?
I see you use the Material for Mkdocs theme for your demao and it's one of its main feature. It would be nice to reuse the colors schemes for the description/title banner :)
plugins:
- glightbox:
touchNavigation: true
loop: false
effect: zoom
slide_effect: slide
width: 100%
height: auto
zoomable: true
draggable: true
skip_classes:
- glightbox-thumb
auto_caption: false
caption_position: bottom
background: white
shadow: true
- privacy
it will work if I comment out the privacy bit.
Specifically the error it throws is
Uncaught TypeError: element.querySelector(...) is null
<anonymous> (index):1066
<anonymous> (index):1065
RxJS 7
No index.ts:44
RxJS 10
No index.ts:44
<anonymous> bundle.ts:133
<anonymous> bundle.ts:318
The offending code it links to is around here var imgSrc = element.querySelector('img').src;
<script>document$.subscribe(() => {document.querySelectorAll('.glightbox').forEach(function(element) {
var imgSrc = element.querySelector('img').src;
element.setAttribute('href', imgSrc);
});
const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});})</script><script>
var livereload = function(epoch, requestId) {
var req = new XMLHttpRequest();
req.onloadend = function() {
I'm just going to turn off privacy for now but I wonder why it does that.
Hello, tried to add the plugin and create a gallery, but it does not seem to work.
Even though when inspecting browser I see the JS loads
Dockerfile
FROM squidfunk/mkdocs-material
COPY requirements.txt .
RUN apk add --no-cache gcc musl-dev
RUN pip install -r requirements.txt
requirements.txt
mkdocs==1.4.2
mkdocs-awesome-pages-plugin==2.2.1
mkdocs-git-revision-date-localized-plugin==0.5.2
mkdocs-material==5.2.2
mkdocs-material-extensions==1.0
mkdocs-minify-plugin==0.3.0
jinja2==3.0.3
beautifulsoup4>=4.11.1
mkdocs-glightbox
mkdocs.conf
plugins:
- search
- awesome-pages
- minify:
minify_html: true
- glightbox:
touchNavigation: true
loop: false
effect: zoom
slide_effect: slide
width: 100%
height: auto
zoomable: false
draggable: false
skip_classes:
- custom-skip-class-name
auto_caption: false
caption_position: bottom
mkdocs.yml
)extra_javascript:
- javascripts/glightbox.min.js
extra_css:
- stylesheets/extra.css
- stylesheets/glightbox.min.css
![Taipei, Taiwan. Credit: Yuyu Liu](/img/jump.jpg){data-gallery="taipei"}
![Taipei, Taiwan. Credit: Yuyu Liu](/img/pit.jpg){data-gallery="taipei"}
im dumb)
I'm usig the latest version of Mkdocs-Material.
In my mkdocs.yml
file, if I comment out those lines:
# plugins:
# - glightbox
Then the search bar is displayed and functions well:
However, when I enable it, it disappears:
plugins:
- glightbox
I have commented out the rest of my mkdocs.yml
file and nothing else seems to impact the search bar.
I have also noticed in that it is not here in your live demo either: https://blueswen.github.io/mkdocs-glightbox/
Hopefully it is a quick fix, thanks!
Has to revert to older version (0.3.7): vcmi/VCMI.eu#34
Because the lightbox only works for cached images. If you open a uncached page: When you click on image you will see the spinner forever an the image isn't loading.
Now, after revert it's working just fine again.
Web console also generates an error:
Uncaught TypeError: URL constructor: is not a valid URL.
Xa index.ts:110
i index.ts:301
RxJS 7
12 [index.ts:110:6](https://vcmi.eu/assets/javascripts/src/templates/assets/javascripts/integrations/instant/index.ts)
It seems a href
url is unset.
I'm not sure if this bug is coming from this library. Or from https://github.com/squidfunk/mkdocs-material by @squidfunk
Is is possible to do something like this
![![This is a reason why that solution work](explaination.png)](solution.png)
As there is a case where I have a plugin that automatically takes images of certain explanations into images so that the user can download and view them as a carousel. But I cant not add an image inside another solution, so I have to copy a large amount of text into the solution with a custom plugin.
Also, there is a suggestion, can we have a tooltip when hovering over a image? it shall show data-title inside a rectangle toolip so the user can read the title without enlarging the image (for example: comparing two images title / two different solutions with similar solution)
Hi there, I just tried to install the glightbox plugin for mkdocs-material (v8.3.9) with poetry, but unfortunately it's not working :-(
Here is what I did:
poetry add mkdocs-glightbox
poetry run mkdocs serve
INFO - Building documentation...
ERROR - Config value: 'markdown_extensions'. Error: Failed to load extension 'glightbox'.
ModuleNotFoundError: No module named 'glightbox'
Aborted with 1 Configuration Errors!
The plugin is installed and I can load it:
poetry run python
Python 3.9.13 (main, May 24 2022, 21:28:31)
[Clang 13.1.6 (clang-1316.0.21.2)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import pkg_resources
>>> named_objects = {}
>>> for ep in pkg_resources.iter_entry_points(group='mkdocs.plugins'):
... named_objects.update({ep.name: ep.load()})
...
>>> named_objects['glightbox']
<class 'mkdocs_glightbox.plugin.LightboxPlugin'>
>>>
Strange ...
Hello, I added plugins: - glightbox
into my mkdocs.yml file, and when it deploys the page, it fails on the action saying "ERROR - Config value 'plugins': The "glightbox" plugin is not installed". Can someone help me sort that out? Cheers
If I add the following to my mkdocs.yml:
plugins:
- glightbox
...then glightbox works as expected - I can click on images to zoom into them, etc. However, the Search field at the top-right of the page disappears. If I remove those lines, the Search field is back. How can I have glightbox and Search at the same time?
after trying a lot the gallery arrow for the next picture dissapeared
I use this config
`
..
theme:
name: simple-blog
plugins:
markdown_extensions:
tried with firefox and chrome.
any thing obvious ? if not what decides if these arrows appear ?
Hello,
I just wanted to bring to your attention that, with the latest update of mkdocs, your plugin triggers a deprecation warning:
INFO - DeprecationWarning: Do not access Theme._vars, instead access the keys of Theme directly.
File ".../.venv/lib/python3.8/site-packages/mkdocs_glightbox/plugin.py", line 104, in on_post_page
if self.using_material or "navigation.instant" in config["theme"]._vars.get(
File ".../.venv/lib/python3.8/site-packages/mkdocs/theme.py", line 87, in _vars
warnings.warn(
Thanks for the plugin,
Kind regards,
Fred
Hi,
Based on squidfunk/mkdocs-material#5208.
Is it possible to add an option to support mermaid js diagrams in the same way as images are supported?
GitHub is also able to display markdown in a way that the mermaid js diagrams become zoomable: https://github.com/squidfunk/mkdocs-material/blob/master/docs/reference/diagrams.md#using-flowcharts
BR
I have a page with ~50 images and it takes forever to build. Just take some existing project and copy an image directive a lot of times to see for yourself.
I have stopped it in the debugger and it hangs in the regex sub of plugin.py around line 139 where it tries to do all the replacements in one go. I guess the look back/ahead of the regex there degenerates when it sees that many image tags.
maybe using the find_all in regexes and then looping over the matches works better?
PS: I think the re.compile in the function would benefit from being on the class level to only be ever executed once
This issue is the continuation of this one: squidfunk/mkdocs-material#6248 where you can find every details and a reproducible example.
In a nutshell:
a[href]
to link external image (certainly because of underlying lightbox behavior)See this comment from @squidfunk:
I've investigated and came to the conclusion that it does not make sense to fix this on our side. Here's why:
Problem
The mkdocs-glightbox plugin currently detects
img
elements during build time (after the site has been rendered as HTML) and wraps them witha
anchor elements. As already noted in #6248 (comment), the privacy plugin only considers assets that are actually rendered to be downloaded. However, the glightbox plugin will wrap the image in an anchor and sethref
to the image. Normally, ana
is a link to an external or internal resource – nothing that is rendered or downloaded without the users consent, thus not under GDPR. This is beyond the scope of the privacy plugin.Why? Because if we would start downloading resources that are referenced in
a[href]
attributes, we would need another way to tell the plugin what not to download. Otherwise the plugin will try to download all external resources, which will make configuration much more challenging and the final site will probably blow up in size.Possible solution
IMHO, there's no need for the glightbox plugin to wrap the
img
elements during build time – glightbox needs JavaScript to function (open the inspector when you click on an image, and you will see that the JavaScript changes several properties, e.g. on the body). As there's no possibility to make it work without JavaScript (correct me if I'm wrong), I think it's a better idea to defer wrapping of image elements into the browser. The glightbox plugin could just mark elements with a specific class or attribute, e.g.data-glightbox
, and provide a small JavaScript that wraps theimg
elements when the page has loaded. This would mean the correct image would be picked up every time.This would not only solve the problem at hand, but also be easier to extend to other resources to be presented in the ligtbox, because very soon, the optimize plugin will receive the capability to generate multiple variants of images and wrap them in picture tags. The glightbox plugin could the pick the appropriate source in the
picture
tag.If you need help getting this to work, @blueswen, let me know. Wrapping an element in JavaScript is quite simple..
Closing as upstream issue.
glightbox itself supports the data-srcset
and data-sizes
attributes for responsive images, could you please add support for that?
Check the last example here:
https://github.com/biati-digital/glightbox/blob/master/README.md
Hi, not sure if this is supposed to work this way. PNG images open and zoom fine, but SVG images are not zoomable at all. Any solution?
Is there an easy way to add a "share to [social]" link to the gallery view of images? It would work nicely below the image and before the caption.
On its own, I can get the glightbox-mkdocs plugin to work without any issues. My images become 'zoomable' which is the desired effect I am looking for.
However, when I import that same repo with the mkdocs-multirepo-plugin, the 'zoomable' feature of my images in markdown no longer are 'zoomable'.
I installed the glightbox-mkdocs
plugin in both my 'parent' multi-repo repo and the child repo, but that did not help.
You can see below that the glightbox
script is missing when hosted on Gitlab pages with the mkdocs-multirepo-plugin
, but the script is present when hosted on my local workstation via mkdocs serve
:
mkdocs serve
Hi,
it would be great to control the behavior for specific images using the attribute-list syntax in combination with some global options, or even by page using the metadata option.
For example, having the ability to:
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.