MkDocs GLightbox

MkDocs插件，支持使用GLightbox的图像灯箱。

GLightbox是一个支持移动端的纯JavaScript灯箱库。

与Material for MkDocs配合使用的实时演示。

依赖项

1. Python包
   1. beautifulsoup4>=4.11.1
2. GLightbox JavaScript文件和CSS文件
   1. GLightbox==3.2.0

用法

1. 从PyPI安装插件

   pip install mkdocs-glightbox
   

2. 将glightbox插件添加到mkdocs.yml的plugins部分

   plugins:
      - glightbox
   

3. 您可以通过在mkdocs.yml中传递选项来自定义插件

   plugins:
      - glightbox:
          touchNavigation: true
          loop: false
          effect: zoom
          width: 100%
          height: auto
          zoomable: true
          draggable: true
   

   选项	默认值	描述
   touchNavigation	true	启用或禁用触摸导航（滑动）。
   loop	false	在结束时循环幻灯片。
   effect	zoom	灯箱打开时效果的名字（zoom, fade, none）。
   width	100%	内联元素和iframe的默认宽度。您可以使用任何单位，例如90%或100vw用于全宽。
   height	auto	内联元素和iframe的默认高度。您可以使用任何单位，例如90%，100vh或auto。
   zoomable	true	启用或禁用可缩放图像。
   draggable	true	启用或禁用鼠标拖动以切换幻灯片。

   有关更多信息，请参阅GLightbox 文档。

4. 为了更大的灵活性，您可以通过特定图像或特定页面禁用灯箱。

许可证

本项目采用MIT许可证 - 有关详细信息，请参阅LICENSE.md文件。