jekyll_picture_tag 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fdaad2f56cc244f8bce4ffcf5689630fe71ec0b7e091d91e289a1dc7d6740d8
-  data.tar.gz: 971d590896ef6396a86c8ce6f6dd7fef46804443b4c2b76226e5e774dc5cd204
+  metadata.gz: 57fe7741c94cf1511eb8824dec643e9acb953b3251b2714b030e662742d62680
+  data.tar.gz: fcfae3154dcfe87509bc4759171ab6f2a27636ab75d6ec20d24b335f8535dc8c
 SHA512:
-  metadata.gz: 77fa8b7e4b3db8839a988f0613b8e3b0257ff92f7e379db12bf9de1da3644acf7d6a6bfa0fb82b900fb71d2e6775d842d2187ec1e13617cf268098f98ad41e12
-  data.tar.gz: b9efeae7cff9bc5a962d9c076d735c00011ad231cbac264b232a29a6f4ec3af101d9f905a0cde61283b0b739b8d9388e92ccad7f600aacccc382c2845edbd71e
+  metadata.gz: af9a456fb275f80eedff3c26a1579c3ce95b2385fd66f1a7e203947de2e16deea596f2e6a1334f5cb475e4d61c26803569bd522a84356a574b826cc071961fa3
+  data.tar.gz: a6fb8984f4fe3b02564a60038d77136d15c5fd1625a1e8b5f654b656494eb8e9b1f7f497436145253e8f241d5cb902243df37ff38511a05b742c5c2de1c5730d

data/docs/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'github-pages', group: :jekyll_plugins
-gem 'jekyll-theme-slate'
+group :jekyll_plugins do
+  gem 'github-pages'
+  gem 'jekyll-rtd-theme'
+end

data/docs/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -28,12 +28,12 @@ GEM
     execjs (2.7.0)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    ffi (1.12.2)
+    ffi (1.13.1)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
-    github-pages (204)
+    github-pages (206)
       github-pages-health-check (= 1.16.1)
-      jekyll (= 3.8.5)
+      jekyll (= 3.8.7)
       jekyll-avatar (= 0.7.0)
       jekyll-coffeescript (= 1.1.1)
       jekyll-commonmark-ghpages (= 0.1.6)
@@ -72,7 +72,7 @@ GEM
       mercenary (~> 0.3)
       minima (= 2.5.1)
       nokogiri (>= 1.10.4, < 2.0)
-      rouge (= 3.13.0)
+      rouge (= 3.19.0)
       terminal-table (~> 1.4)
     github-pages-health-check (1.16.1)
       addressable (~> 2.3)
@@ -80,13 +80,13 @@ GEM
       octokit (~> 4.0)
       public_suffix (~> 3.0)
       typhoeus (~> 1.3)
-    html-pipeline (2.12.3)
+    html-pipeline (2.13.0)
       activesupport (>= 2)
       nokogiri (>= 1.4)
     http_parser.rb (0.6.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.5)
+    jekyll (3.8.7)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -136,6 +136,8 @@ GEM
       addressable (~> 2.0)
       jekyll (>= 3.5, < 5.0)
       rubyzip (>= 1.3.0)
+    jekyll-rtd-theme (0.1.6)
+      github-pages (~> 206)
     jekyll-sass-converter (1.5.2)
       sass (~> 3.4)
     jekyll-seo-tag (2.6.1)
@@ -202,9 +204,9 @@ GEM
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.14.0)
+    minitest (5.14.1)
     multipart-post (2.1.1)
-    nokogiri (1.10.9)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     octokit (4.18.0)
       faraday (>= 0.9)
@@ -215,7 +217,7 @@ GEM
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rouge (3.13.0)
+    rouge (3.19.0)
     ruby-enum (0.8.0)
       i18n
     rubyzip (2.3.0)
@@ -236,14 +238,14 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   github-pages
-  jekyll-theme-slate
+  jekyll-rtd-theme
 
 BUNDLED WITH
    2.1.4

data/docs/_config.yml

@@ -1,13 +1,9 @@
-theme: jekyll-theme-slate
+remote_theme: rundocs/jekyll-rtd-theme
+
 title: Jekyll Picture Tag
+description: Images for Jekyll, done correctly.
+lang: en-US
 
-url: ''
 baseurl: '/jekyll_picture_tag'
-
-defaults:
-  - 
-    scope: 
-      path: ''
-    values:
-      layout: directory
-  
+readme_index: 
+  with_frontmatter: true

data/docs/devs/contributing/code.md

@@ -0,0 +1,44 @@
+---
+sort: 4
+---
+
+# Code Guidelines
+
+* Generally, go for straightforward and readable rather than terse and clever. I'm not actually a
+  very good programmer; I need simple code that's easy to understand.
+
+* Refactoring is welcome, especially in the name of the previous point.
+
+* I'm very reluctant to introduce breaking changes to configuration settings. This rule isn't
+  absolute, but I'm not going to do it without a good reason.
+
+* Don't disable cops without strong justification.
+
+* I generally try to write tests before writing code, especially when fixing bugs. This
+  gives us some confidence that what we think we're testing and what we're actually testing aren't
+  too different.
+
+## Hard rules
+
+These aren't the rules for submitting a pull request, these are the rules for merging into master.
+I'm thrilled to receive any help at all, and I'm more than happy to help with meeting these
+criteria:
+
+* Liquid tag syntax can only be extended; no breaking changes. I'm not willing to force
+  users to dig through their entire site and change every picture tag in order to update to the
+  latest version.
+
+* Maintain "no configuration required" - a new user must be able to add JPT to their gemfile, bundle
+  install, and start writing picture tags in their site without touching a yml file.
+
+* 100% test coverage (Meaning that when running the unit and integration tests together, every line
+  of code in the `lib` folder must run at least once.)
+
+* No failing tests
+
+* No rubocop warnings
+
+### Thanks!
+
+As I said, don't let any of the rules & guidelines scare you away. They're the rules for merging
+into master, not submitting a pull request. I'm thrilled to receive any help at all.

data/docs/devs/contributing/docs.md

@@ -0,0 +1,13 @@
+---
+sort: 2
+---
+
+# Docs
+
+They run on github pages, which is based on jekyll. You can preview as you edit:
+
+0. Follow the [setup instructions](setup)
+1. `$ cd docs`
+2. `$ bundle install`
+3. `$ bundle exec jekyll serve`
+4. In a web browser, navigate to `localhost:4000/jekyll_picture_tag/`

data/docs/devs/contributing/index.md

@@ -0,0 +1,15 @@
+---
+---
+# Contributing
+
+Bug reports, feature requests, and feedback are very welcome, either through
+github issues or via email: robert@buchberger.cc 
+
+Pull requests are encouraged! I'm happy to answer questions and provide
+assistance along the way.  Don't let any of the recommendations/requests in this
+guide stop you from submitting one.
+
+I think one of the biggest opportunities for improvement in this plugin is its
+documentation. I'd really love help here, and all you need to know is markdown.
+
+{% include list.liquid %}

data/docs/devs/contributing/setup.md

@@ -0,0 +1,13 @@
+---
+sort: 1
+---
+
+## Setup
+
+It's pretty standard:
+
+```
+$ git clone git@github.com:rbuchberger/jekyll_picture_tag.git
+$ cd jekyll_picture_tag
+$ bundle install
+```

data/docs/devs/contributing/testing.md

@@ -0,0 +1,41 @@
+---
+sort: 3
+---
+
+## How to run the tests
+
+You probably only need to use docker if it's inconvenient to install ImageMagick 7.
+
+### Bare Metal
+
+```note
+Depending on your environment, you may need to prefix all rake commands with
+`bundle exec`.
+```
+
+`rake test` runs the test suite (both unit tests and integration tests). Ignore the mini_magick
+`method redefined` warnings (unless you know how to fix them?) 
+
+`rake unit` runs just the unit tests, while `rake integration` runs the integration tests. The unit
+test coverage isn't stellar, but both unit and integration tests together hit 100%.
+
+Speaking of coverage, simplecov is set up -- you'll get a measurement of coverage in the test output
+and a nice report in the `coverage` directory. I'd like to move to mutation based coverage testing,
+but that's a project for another day.
+
+The tests do output a few images to the `/tmp/` directory, which I'm pretty sure means it won't work
+on Windows. This is fixable if there is a need, so if that gets in your way just ask.
+
+`rake rubocop` checks code formatting, `rake rubocop:auto_correct` will try to fix any rubocop
+issues, if possible.
+
+`rake` will run all tests and rubocop.
+
+### Docker
+
+The following commands will build and run the tests inside a docker image.
+
+```bash
+$ docker build . -t jpt
+$ docker run -t jpt
+```

data/docs/devs/index.md

@@ -0,0 +1,7 @@
+---
+sort: 2
+---
+
+# Development
+
+{% include list.liquid %}

data/docs/{releases.md → devs/releases.md}

@@ -1,11 +1,17 @@
 ---
 ---
 # Release History
+* 1.12.0 July 30, 2020
+  * Documentation overhaul. Now with 87% less scrolling!
+  * Rename `markup_presets` and `media_presets` to `presets` and
+    `media_queries`. The old names were bad and caused confusion. The old names
+    will continue to work until the next major version is released.
 * 1.11.0 July 27, 2020
   * **Width and height attribute support!** Begone, page reflow.
   * Cache image information between builds
-  * Change image naming format. This update will trigger all images to be regenerated, so you may
-    want to delete your generated images folder beforehand.
+  * Change image naming format. This update will trigger all images to be
+    regenerated, so you may want to delete your generated images folder
+    beforehand.
 * 1.10.2 July 6, 2020
   * Bugfix for fallback image files not actually getting generated
 * 1.10.1 July 2, 2020
@@ -17,23 +23,25 @@
 * 1.9.0 Feb 2, 2020
   * Add `fast_build` global setting
   * Add `disabled` global setting
-  * Reduce unnecessary disk IO; sites with many source images should see build times improve when
-    no new images need to be generated.
-  * Add support for empty attributes; specifically so best-practice for decorative images (`alt=""`)
-    is possible.
+  * Reduce unnecessary disk IO; sites with many source images should see build
+  times improve when no new images need to be generated.
+  * Add support for empty attributes; specifically so best-practice for
+    decorative images (`alt=""`) is possible.
 * 1.8.0 Nov 25, 2019
   * Add `data_sizes` setting for the `data_` family of output formats.
 * 1.7.1 Nov 14, 2019
   * Fix some HTML attribute related bugs
   * Add a few items to the FAQ
 * 1.7.0 Aug 12, 2019
-  * Add support for setting generated image quality, either generally or specific to given
-    formats.
+  * Add support for setting generated image quality, either generally or
+    specific to given formats.
   * Add support for spaces and other url-encoded characters in filenames
-  * Documentation restructure - Moved it out of the wiki, into the `docs` folder.
+  * Documentation restructure - Moved it out of the wiki, into the `docs`
+    folder.
   * Bugfix: Fallback image width will now be checked against source image width.
   * Bugfix: Minor fix to nomarkdown wrapper output
-  * link_source will now target the base source image, rather than finding the biggest one.
+  * link_source will now target the base source image, rather than finding the
+    biggest one.
   * Remove fastimage dependency, add addressable dependency.
   * Moderately significant refactoring and code cleanup 
   * Decent set of tests added
@@ -44,14 +52,15 @@
   * better `{::nomarkdown}` necessity detection
   * allow user to override `{::nomarkdown}` autodetection
 * 1.4.0 Jun 26, 2019:
-  * Rename gem from `jekyll-picture-tag` to `jekyll_picture_tag`, allowing us to use rubygems again.
+  * Rename gem from `jekyll-picture-tag` to `jekyll_picture_tag`, allowing us to
+    use rubygems again.
   * Add new output format: `naked_srcset`.
 * 1.3.1 Jun 21, 2019: Bugfix
 * 1.3.0 Jun  7, 2019:
   * Initial compatibility with Jekyll 4.0
   * bugfixes
-  * change to generated image naming-- The first build after this update will be longer, and you
-    might want to clear out your generated images.
+  * change to generated image naming-- The first build after this update will be
+    longer, and you might want to clear out your generated images.
 * 1.2.0 Feb  9, 2019:
   * Add nomarkdown fix
   * noscript option
@@ -62,7 +71,8 @@
   * auto-orient images before stripping metadata
 * 1.0.2 Jan 18, 2019: Fix ruby version specification
 * 1.0.1 Jan 13, 2019: Added ruby version checking
-* **1.0.0** Nov 27, 2018: Rewrite from the ground up. See the [migration guide]({{ site.baseurl }}/migration).
+* **1.0.0** Nov 27, 2018: Rewrite from the ground up. See the 
+* [migration guide]({{ site.baseurl }}/users/notes/migration).
 * 0.2.2 Aug  2, 2013: Bugfixes
 * 0.2.1 Jul 17, 2013: Refactor again, add Liquid parsing.
 * 0.2.0 Jul 14, 2013: Rewrite code base, bring in line with Jekyll Image Tag.

data/docs/index.md

@@ -1,12 +1,15 @@
 ---
-id: quickstart
 ---
 
-# Quick start / Demo
+# Jekyll Picture Tag
+
+Responsive Images, Done Correctly.
+
+## Quick start / Demo
 
 **All configuration is optional.** Here's the simplest possible use case:
 
-1. [Install]({{ site.baseurl }}/installation)
+1. [Install]({{ site.baseurl }}/users/installation)
 
 2. Write this: {% raw %} `{% picture test.jpg %}` {% endraw %}
 
@@ -31,24 +34,31 @@ id: quickstart
 Create `_data/picture.yml`, add the following:
 
 ```yml
-markup_presets:
+presets:
   default:
     formats: [webp, original]
 ```
-**Note:** Order matters! `[webp, jpg]` will offer the browser webp-images first. The browser will pick the *first* format it can work with. So if the order is reversed `[jpg, webp]` it will use the jpg image before the webp.
+
+**Note:** Order matters! `[webp, jpg]` will offer webp-images first.  The
+browser will pick the *first* format it can work with. So if the order is
+reversed `[jpg, webp]` it will use the jpg image before the webp.
 
 ### Here's a more complete demonstration:
 
-[Presets]({{ site.baseurl }}/presets) are named collections of settings, and come in 2 kinds: Media
-Presets are named CSS media queries, and Markup Presets determine the output text and images. You
-choose one with the second [tag parameter]({{ site.baseurl }}/usage), or omit for the `default` (as
-in these examples).  They are located in `_data/picture.yml`. Here's an example:
+[Presets]({{ site.baseurl }}/users/presets) are named collections of settings.
+You choose one with the second [tag
+parameter]({{site.baseurl}}/users/liquid_tag), or omit for the `default` (as in
+these examples). They are located in `_data/picture.yml`. Alongside `presets`,
+we also set named `media_queries` for easy reference. Here's an example:
+
 
 ```yml
-media_presets:
+# _data/picture.yml
+
+media_queries:
   mobile: 'max-width: 600px'
 
-markup_presets:
+presets:
   default:
     widths: [600, 900, 1200]
     formats: [webp, original]
@@ -57,9 +67,9 @@ markup_presets:
     size: 500px
 ```
 
-Imagemagick can easily crop images to an aspect ratio, though you should **read the whole
-installation guide before using this feature**. With the above preset, if you write this:
-
+Imagemagick can easily crop images to an aspect ratio, though you should **read
+the whole installation guide before using this feature**. With the above preset,
+if you write this:
 
 {% raw %}
 `{% picture test.jpg 3:2 mobile: test2.jpg 1:1 --alt Alternate Text %}`
@@ -72,43 +82,49 @@ You'll get something like this:
 
 <picture>
   <source
-    sizes="(max-width: 600px) 80vw, 600px"
+    type="image/webp"
     media="(max-width: 600px)"
+    sizes="(max-width: 600px) 80vw, 600px"
     srcset="
       /generated/test2-600-21bb6fGUW.webp   600w,
       /generated/test2-900-21bb6fGUW.webp   900w,
       /generated/test2-1200-21bb6fGUW.webp 1200w
-    "
-    type="image/webp">
+    ">
   <source
+    type="image/webp"
     sizes="(max-width: 600px) 80vw, 600px"
     srcset="
       /generated/test-600-195f7d192.webp   600w,
       /generated/test-900-195f7d192.webp   900w,
       /generated/test-1200-195f7d192.webp 1200w
-    "
-    type="image/webp">
+    ">
   <source
-    sizes="(max-width: 600px) 80vw, 600px"
+    type="image/jpeg"
     media="(max-width: 600px)"
+    sizes="(max-width: 600px) 80vw, 600px"
     srcset="
       /generated/test2-600-21bb6fGUW.jpg   600w,
       /generated/test2-900-21bb6fGUW.jpg   900w,
       /generated/test2-1200-21bb6fGUW.jpg 1200w
-    "
-    type="image/jpeg">
+    ">
   <source
+    type="image/jpeg"
     sizes="(max-width: 600px) 80vw, 600px"
     srcset="
       /generated/test-600-195f7d192.jpg   600w,
       /generated/test-900-195f7d192.jpg   900w,
       /generated/test-1200-195f7d192.jpg 1200w
-    "
-    type="image/jpeg">
+    ">
   <img src="/generated/test-800-195f7dGUW.jpg" alt="Alternate Text">
 </picture>
 ```
 
-In other words, you have the art direction, format switching, and resolution switching problems
-*solved*, with a one-liner and a nicely readable config file that is 1/3 as long as the output
-markup. Lighthouse is happy, and you don't even need to crop things yourself.
+In other words, you have the art direction, format switching, and resolution
+switching problems *solved*, with a one-liner and a nicely readable config file
+that is 1/3 as long as the output markup. Lighthouse is happy, and you don't
+even need to crop things yourself.
+
+That isn't a complete demonstration of Jekyll Picture Tag's feature set; it can
+(among other things) add width & height attributes to prevent page reflow, add a
+link to the source image (or anywhere else), and adjust image quality. See the
+docs for more.