JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 125
  • Score
    100M100P100Q79984F
  • License MIT

A gitbook plugin to show image by lightbox.

Package Exports

  • gitbook-plugin-lightbox

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gitbook-plugin-lightbox) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gitbook-plugin-lightbox

A gitbook plugin to show image by lightbox

Requirement

  • Gitbook >= 3.0.0

Installation

Add the below to your book.json file, then run gitbook install :

{
  "plugins": ["lightbox"]
}

Usage

Just add image as normal, this plugin will do all things for you.

Config

There are something you can tweak!

jQuery

If you have already include jQuery in other place, you can set:

{
  "pluginsConfig": {
    "lightbox": {
      "includeJQuery": false
    }
  }
}

Same lightbox id

If you want to use next/prev button, you can set:

{
  "pluginsConfig": {
    "lightbox": {
      "sameUuid": true
    }
  }
}

If you want to set lightbox configration, yo can set:

{
  "pluginsConfig": {
    "lightbox": {
      "options": {
        "resizeDuration": 200,
        "wrapAround": true
      }
    }
  }
}