cheesy-gallery 0.8.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7b31592195513a15c1283ba531e6de02357f7c2bfb9d1aaa312df061e5cd6f8b
4
- data.tar.gz: 66e4b206545aff52859a71ed9da66b0a600075029e6988de7c3f96a659c0a250
3
+ metadata.gz: f2e39647876bfa81d7b73483ea57fb6668106f7a48f0cfee79999afcd6267e75
4
+ data.tar.gz: 46a5588227d07a6ee694717d21b531260df69fc1f98ad54e7b6fe7ac7dea0a2d
5
5
  SHA512:
6
- metadata.gz: 7868feeaf207a4b67c3818407a67d766c1c8cb563897f0e98938120934cd9b433c865922be2d6007055c23c489c3182afcabe6d7ef369e6af9f907ed3591ba6e
7
- data.tar.gz: 12f0769a64e4a58d1eaf870e788d35d49d234cb6b1e1a79f446238dfad4ee7d96f8468b0d6533b6d7112237bf397274ed166b8a1987ee51284a494285191f84a
6
+ metadata.gz: 1848096b99b1c78c58cc2f8709daff15b85c98ad638ff5b2c934df07ab198814cf7faccf9e5dec8edb4cc1e92e81eccb1d8d6559f0a1d98e711c238fd2f9fdcf
7
+ data.tar.gz: a01a1706db9a6b909baefa62094935fde7c53e3eec9572f0831713182bf4f1209f14f1d8700fb42b7ec1ea7637e67ccb8fed3fef126203d9ea252e23b721dbe1
data/README.md CHANGED
@@ -1,39 +1,55 @@
1
1
  # Cheesy::Gallery
2
2
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cheesy/gallery`. To experiment with that code, run `bin/console` for an interactive prompt.
4
-
5
- TODO: Delete this and the text above, and describe your gem
3
+ This is a jekyll photo gallery to manage large amounts of galleries and pictures. You can see the results at https://www.cheesy.at/fotos/.
6
4
 
7
5
  ## Installation
8
6
 
9
- Add this line to your application's Gemfile:
7
+ Follow Jekyll's documentation on [how to install plugins](https://jekyllrb.com/docs/plugins/installation/) using "cheesy-gallery" as name for the gem and plugin.
8
+
9
+ ## Usage
10
+
11
+ After successful installation, enable gallery processing for a subdirectory of your site.
12
+ For this example, the folder is called `_my_gallery`:
10
13
 
11
- ```ruby
12
- gem 'cheesy-gallery'
14
+ ```yaml
15
+ collections:
16
+ my_gallery:
17
+ cheesy-gallery: true
13
18
  ```
14
19
 
15
- And then execute:
20
+ From now on, every Jekyll build will take all JPGs in all folders under `_my_gallery` and create a gallery for each folder, linking them according to their structure in the file system.
16
21
 
17
- $ bundle
22
+ To add a thumbnail to a gallery, put it inside the gallery folder and call it `thumbnail.jpg`.
18
23
 
19
- Or install it yourself as:
24
+ Frontmatter, like titles, etc., are read from the `index.md` file in the gallery.
20
25
 
21
- $ gem install cheesy-gallery
26
+ Galleries and their contents are sorted by filename.
22
27
 
23
- ## Usage
28
+ To layout galleries, check out the [example layout](spec/fixtures/test_site/_layouts/gallery.html) and adapt it to your site's style.
29
+
30
+ If you want an inline display of your photos, I recommend [glightbox](https://github.com/biati-digital/glightbox) by [biati-digital](https://github.com/biati-digital). Add their CSS and JavaScript to your assets, and link them in the `<head>` of your site:
24
31
 
25
- TODO: Write usage instructions here
32
+ ```html
33
+ <link rel="stylesheet" href="{{ "/assets/glb/glightbox.min.css" | relative_url }}">
34
+ <script src="{{ "/assets/glb/glightbox.min.js" | relative_url }}"></script>
35
+ ```
36
+
37
+ Then, in the gallery layout, add `data-gallery="gallery"` attribute to the `<a>` tag linking to each image, and put
38
+
39
+ ```html
40
+ <script type="text/javascript">
41
+ const lightbox = GLightbox({selector: '*[data-gallery]'});
42
+ </script>
43
+ ```
44
+
45
+ at the bottom of the layout.
26
46
 
27
47
  ## Development
28
48
 
29
- After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
49
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. There is also a test site in `spec/fixtures/test_site` that you can use to try out changes.
30
50
 
31
51
  To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
52
 
33
53
  ## Contributing
34
54
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/DavidS/cheesy-gallery. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
36
-
37
- ## Code of Conduct
38
-
39
- Everyone interacting in the Cheesy::Gallery project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/DavidS/cheesy-gallery/blob/main/CODE_OF_CONDUCT.md).
55
+ Bug reports and pull requests are welcome on GitHub at https://github.com/DavidS/cheesy-gallery. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. See [code of conduct](https://github.com/DavidS/cheesy-gallery/blob/main/CODE_OF_CONDUCT.md) for a local copy.
@@ -2,5 +2,5 @@
2
2
  # frozen_string_literal: true
3
3
 
4
4
  module CheesyGallery
5
- VERSION = '0.8.0'
5
+ VERSION = '1.0.0'
6
6
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cheesy-gallery
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.0
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Schmitt
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2021-05-31 00:00:00.000000000 Z
11
+ date: 2021-06-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler