|
||
---|---|---|
_includes | ||
_layouts | ||
_plugins | ||
photos/202404_eclipse | ||
Gemfile | ||
README.md | ||
_config.yml | ||
index.md |
README.md
Gallery Generator
This is a Jekyll plugin that generates galleries from directories full of images. It uses RMagick to create thumbnails.
This plugin is quite minimalist. It generates galleries with no pagination, no sub-galleries, and no descriptions. See my gallery for an example of what it looks like.
Usage
-
Install the
jekyll-gallery-generator
gem, either by runninggem install jekyll-gallery-generator
or by addinggem 'jekyll-gallery-generator'
to yourGemfile
and runningbundle
. -
Add
jekyll-gallery-generator
to the plugins list in your_config.yml
:
plugins:
- jekyll-gallery-generator
- Copy your image directories into
jekyll-site/photos/
. Here's what my directory structure looks like:
$ ls jekyll-site/photos
best/ chile_trip/ japan_trip/
$ ls jekyll-site/photos/chile_trip
IMG_1039.JPG IMG_1046.JPG IMG_1057.JPG
- Run
jekyll build
and be patient. It can take a while to generate all the thumbnails on the first run. After that, you should have pretty pictures.
Jekyll Photo Gallery
I want to share my jekyll photo gallery, simple, functional, mobile friendly and most essential, pretty! The gallery is based on the design from Henrrique Gusso and utilizes the jekyll gallery generator plugin to do most of the heavy lifting (with some minor changes).
Dependencies
(copied from the plugin repo)
- ImageMagick
- RMagick
- exifr
- Ruby >= 2.1
Install dependencies on OS X
brew install imagemagick rbenv
rbenv install 2.4.0
rbenv global 2.4.0
gem install rmagick exifr
Install dependencies on Ubuntu
apt install libmagick++-dev
gem install rmagick exifr
Configuration
This plugin reads several config options from _config.yml
. The following options are supported (default settings are shown):
# The following options are for individual galleries.
gallery:
dir: photos # root folder with all the pictures
title: "Photos"
sort_field: "date" # sort pictures by date
title_prefix: "" # title prefix
symlink: false # false: copy images into _site. true: create symbolic links (saves disk space)
thumbnail_size: #
y: 450 #
retina: 1.5 #
galleries:
2017_Berlin: # folder name
name: "Berlin" # gallery name
date: "2017/08/01" # gallery date
best_image: 0062.jpg # best photo for gallery blur image and gallery index
awesome_stuff:
best_image: snaileo_gonzales.jpg
sort_reverse: true # Reverse sort images in gallery.
secret_stuff:
hidden: true # Don't show this gallery on the index page. People must guess the URL.
with_info:
info:
desc: "Gallery Description" # Info fields can be used in custom templates.
Overriding layouts
If you want to customize the templates used by this generator, copy gallery_index.html
and gallery_page.html
to your Jekyll site's _layouts
:
cp lib/gallery_index.html jekyll-site/_layouts/
cp lib/gallery_page.html jekyll-site/_layouts/
Thanks to
- The people behind jekyll project
- Geoff Greer for the script
- Gusso for the design