Socket
Socket
Sign inDemoInstall

mkdocs-glightbox-tables

Package Overview
Dependencies
0
Maintainers
1
Alerts
File Explorer

Install Socket

Protect your apps from supply chain attacks

Install

mkdocs-glightbox-tables

MkDocs plugin supports image and table lightbox with GLightbox.

    0.2.3

Maintainers
1

Readme

MkDocs GLightbox

PyPI version PyPI downloads

A MkDocs plugin supports image lightbox with GLightbox.

GLightbox is a pure javascript lightbox library with mobile support.

Live demo with Material for MkDocs.

Dependency

  1. Python Package
    1. beautifulsoup4>=4.11.1
  2. GLightbox javascript file and css file
    1. GLightbox==3.2.0

Usage

  1. Install plugin from pypi

    pip install mkdocs-glightbox
    
  2. Add glightbox plugin to your mkdocs.yml plugins sections:

    plugins:
       - glightbox
    
  3. You may customize the plugin by passing options in mkdocs.yml:

    plugins:
       - glightbox:
           touchNavigation: true
           loop: false
           effect: zoom
           width: 100%
           height: auto
           zoomable: true
           draggable: true
    
    OptionDefaultDescription
    touchNavigationtrueEnable or disable the touch navigation (swipe).
    loopfalseLoop slides on end.
    effectzoomName of the effect on lightbox open. (zoom, fade, none)
    width100%Default width for inline elements and iframes. You can use any unit for example 90% or 100vw for full width.
    heightautoDefault height for inline elements and iframes. You can use any unit for example 90%, 100vh or auto.
    zoomabletrueEnable or disable zoomable images.
    draggabletrueEnable or disable mouse drag to go prev and next slide.

    Check more options information on GLightbox Docs.

  4. For more flexibility, you can disable lightbox by a specific image or a specific page.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Keywords

FAQs


Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc