Netdocs
glightbox
Type to start searching
    • Home
    • Setup
    • Writing docs
    • Deployment
    • Development
    • About
    • Home
    • Setup
      • Installation
      • Quick start
      • Authoring environment
      • Configuration
      • Theme
      • CLI reference
      • Build validation
      • Migrating from MkDocs
      • Markdown extensions
      • Page metadata
      • Code blocks
      • Grids
      • Mermaid diagrams
      • Admonitions & tabs
      • Plugins
        • abbreviations
        • link-notes
        • arithmatex (math)
        • b64 (image embed)
        • blog
        • calculator
        • file-filter
        • git-revision-date
        • glightbox
          • Usage
          • Attribution
        • macros
        • meta
        • redirects
        • rss
        • search
        • snippets
        • social
        • table-reader
        • tags
        • typeset
        • versioning
      • Publishing
      • Docker
      • Packaging
      • Building for offline usage
      • Build lifecycle & hook order
      • Events & callbacks reference
      • External plugins
      • Front-end dependencies
      • Versioning & release tags
      • Netdocs vs MkDocs
      • Performance benchmarks
      • Attributions
    • Writing docs
    • Plugins

    glightbox

    Adds an image lightbox powered by GLightbox. Content images are wrapped in lightbox links and open in a zoomable overlay with touch navigation.

    Usage

    Enable the plugin — no options required:

    { "name": "glightbox" }
    

    The plugin injects the GLightbox CSS/JS and an initializer that wraps every .md-content img (that isn't already linked) so clicking an image opens it in the lightbox.

    Attribution

    Behavior is modeled on mkdocs-glightbox + GLightbox (MIT). See Attributions.

    Previous
    git-revision-date
    Next
    macros
    Netdocs — a derivative of MkDocs-Material (MIT).
    Built with Netdocs, a derivative of MkDocs-Material