├── .gitignore ├── .travis.yml ├── Gemfile ├── LICENSE ├── NOTICE ├── README.md ├── jekyll-gallery-generator.gemspec ├── lib ├── gallery_index.html ├── gallery_page.html └── jekyll-gallery-generator.rb └── script └── test /.gitignore: -------------------------------------------------------------------------------- 1 | *.gem 2 | .bundle 3 | Gemfile.lock 4 | spec/dest 5 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | 3 | rvm: 4 | - 2.4 5 | 6 | before_script: bundle update 7 | script: "script/test" 8 | sudo: false 9 | cache: bundler 10 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | gemspec 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Jekyll Gallery Generator 2 | Copyright 2012-2015 Geoff Greer 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Gallery Generator 2 | 3 | This is a [Jekyll plugin](http://jekyllrb.com/docs/plugins/) that generates galleries from directories full of images. It uses [RMagick](http://rmagick.rubyforge.org/) to create thumbnails. 4 | 5 | This plugin is quite minimalist. It generates galleries with no pagination, no sub-galleries, and no descriptions. [See my gallery](http://geoff.greer.fm/photos/) for an example of what it looks like. 6 | 7 | [](https://rubygems.org/gems/jekyll-gallery-generator) 8 | 9 | [](https://travis-ci.org/ggreer/jekyll-gallery-generator) 10 | 11 | [](https://floobits.com/ggreer/jekyll-gallery-generator/redirect) 12 | 13 | 14 | ## Usage 15 | 16 | 1. Install the `jekyll-gallery-generator` gem, either by running `gem install jekyll-gallery-generator` or by adding `gem 'jekyll-gallery-generator'` to your `Gemfile` and running `bundle`. 17 | 18 | 2. Add `jekyll-gallery-generator` to the plugins list in your `_config.yml`: 19 | 20 | ```yaml 21 | plugins: 22 | - jekyll-gallery-generator 23 | ``` 24 | 25 | 3. Copy your image directories into `jekyll-site/photos/`. Here's what my directory structure looks like: 26 | 27 | ```bash 28 | $ ls jekyll-site/photos 29 | best/ chile_trip/ japan_trip/ 30 | $ ls jekyll-site/photos/chile_trip 31 | IMG_1039.JPG IMG_1046.JPG IMG_1057.JPG 32 | ``` 33 | 34 | 4. 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. 35 | 36 | 37 | ## Dependencies 38 | 39 | * [ImageMagick](http://www.imagemagick.org/) 40 | * [RMagick](https://github.com/rmagick/rmagick) 41 | * [exifr](https://github.com/remvee/exifr/) 42 | * [Ruby](https://www.ruby-lang.org) >= 2.1 43 | 44 | ### Install dependencies on OS X 45 | 46 | ```bash 47 | brew install imagemagick rbenv 48 | rbenv install 2.4.0 49 | rbenv global 2.4.0 50 | gem install rmagick exifr 51 | ``` 52 | 53 | ### Install dependencies on Ubuntu 54 | 55 | ```bash 56 | apt install libmagick++-dev 57 | gem install rmagick exifr 58 | ``` 59 | 60 | ## Configuration 61 | 62 | This plugin reads several config options from `_config.yml`. The following options are supported (default settings are shown): 63 | 64 | ```yaml 65 | gallery: 66 | dir: photos # Path to the gallery 67 | symlink: false # false: copy images into _site. true: create symbolic links (saves disk space) 68 | title: "Photos" # Title for gallery index page 69 | title_prefix: "Photos: " # Title prefix for gallery pages. Gallery title = title_prefix + gallery_name 70 | sort_field: "date_time" # How to sort galleries on the index page. 71 | # Possible values are: title, date_time, best_image 72 | thumbnail_size: 73 | x: 400 # max width of thumbnails (in pixels) 74 | y: 400 # max height of thumbnails (in pixels) 75 | # The following options are for individual galleries. 76 | galleries: 77 | chile_trip: 78 | best_image: IMG_1068.JPG # The image to show on the gallery index page. Defaults to the last image. 79 | japan_trip: 80 | best_image: IMG_0690.JPG 81 | name: "日本の旅" # Defaults to directory name, replacing _ with spaces & capitalizing words. 82 | awesome_stuff: 83 | best_image: snaileo_gonzales.jpg 84 | sort_reverse: true # Reverse sort images in gallery. 85 | secret_stuff: 86 | hidden: true # Don't show this gallery on the index page. People must guess the URL. 87 | with_info: 88 | info: 89 | desc: "Gallery Description" # Info fields can be used in custom templates. 90 | ``` 91 | 92 | 93 | ## Overriding layouts 94 | 95 | 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`: 96 | 97 | cp lib/gallery_index.html jekyll-site/_layouts/ 98 | cp lib/gallery_page.html jekyll-site/_layouts/ 99 | -------------------------------------------------------------------------------- /jekyll-gallery-generator.gemspec: -------------------------------------------------------------------------------- 1 | Gem::Specification.new do |spec| 2 | spec.name = "jekyll-gallery-generator" 3 | spec.summary = "Generate galleries with thumbnails for your Jekyll site." 4 | spec.version = "1.2.4" 5 | spec.authors = ["Geoff Greer"] 6 | spec.email = "geoff@greer.fm" 7 | spec.homepage = "https://github.com/ggreer/jekyll-gallery-generator" 8 | spec.licenses = ["Apache-2.0"] 9 | 10 | spec.files = `git ls-files -z`.split("\x0") 11 | spec.require_paths = ["lib"] 12 | 13 | spec.requirements << "imagemagick, >=v6.9 (needed by RMagick)" 14 | 15 | spec.add_runtime_dependency "exifr", "~> 1.3" 16 | spec.add_runtime_dependency "rmagick", "~> 4.1.1" 17 | 18 | spec.add_development_dependency 'jekyll', '~> 3.8', '>= 3.8.3' 19 | spec.add_development_dependency "bundler", "~> 1.6" 20 | end 21 | -------------------------------------------------------------------------------- /lib/gallery_index.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: page 3 | --- 4 | 15 | {% for gallery in page.galleries %} 16 |