https://github.com/appfoundry/jekyll-lightbox

Simple Jekyll tag for Lightbox
https://github.com/appfoundry/jekyll-lightbox

Last synced: 8 days ago
JSON representation

Simple Jekyll tag for Lightbox

• Host: GitHub
• URL: https://github.com/appfoundry/jekyll-lightbox
• Owner: appfoundry
• License: mit
• Created: 2014-09-15T10:04:39.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2019-09-04T09:27:37.000Z (about 5 years ago)
• Last Synced: 2024-08-02T15:46:21.728Z (3 months ago)
• Language: Ruby
• Size: 9.77 KB
• Stars: 21
• Watchers: 2
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Jekyll Lightbox Plugin

A very simple Jekyll tag for including lightbox images in your jekyll powered website.

## Installation

* Install Lightbox as instructed on [their website](http://lokeshdhakar.com/projects/lightbox2/)

* Copy the `lightbox.rb` file to your Jekyll `_plugins` folder

## Usage

Use this plugin as a Jekyll tag in any of your pages as follows:

```

{% lightbox images/appfoundry.png --thumb="images/appfoundry-thumb.png" --data="appfoundry_image_set" --title="The AppFoundry Logo" --alt="This is our logo" --img-style="max-width:80%;" --class="yourclass" %}

```

This will ouput:

```html



  



```

The options explained:

* **--thumb**: (optional) corresponds to Lightbox undocumented thumbnail feature

* **--data**: corresponds to the Lightbox `data-lightbox` attribute

* **--title**: corresponds to the Lightbox `data-title` attribute

* **--alt**: (optional) image `alt` value. If ommitted, the value of `title` is used

* **--img-style**: (optional) any inline `CSS` you would like to apply to your image

* **--class**: (optional) any class you would like to apply to your image

## Versioning

* Current version: **1.0**

## Contact

Feel free to email [email protected] with questions or comments.

## License

This project is licensed under the terms of the MIT license.