From 7d45104e7f78fa2d3d2025a1bd16fcfb28516245 Mon Sep 17 00:00:00 2001 From: Blueswen Date: Sun, 17 Jul 2022 18:13:18 +0800 Subject: [PATCH] Added mkdocs-glightbox as a recommended plugin (#4130) --- docs/reference/images.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/reference/images.md b/docs/reference/images.md index e8c223897..bd2082715 100644 --- a/docs/reference/images.md +++ b/docs/reference/images.md @@ -152,3 +152,18 @@ hash fragment to the image URL: [color palette toggle]: ../setup/changing-the-colors.md#color-palette-toggle [Zelda light world]: ../assets/images/zelda-light-world.png#only-light [Zelda dark world]: ../assets/images/zelda-dark-world.png#only-dark + +## Lightbox + +The [mkdocs-glightbox](https://github.com/blueswen/mkdocs-glightbox) plugin supports adding the lightbox(zoom) effect on all image in each page with [GLightbox](https://github.com/biati-digital/glightbox). As always, it can be installed with pip: + +```bash +pip install mkdocs-glightbox +``` + +Then, add the following lines to mkdocs.yml: + +```mk +plugins: + - glightbox +```