jekyll-highres-link 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76de01644f80d95feda4b06aaa48d2b60cfe68671bbcd8145b0ae894263d903c
+  data.tar.gz: 9cd6348a14ef8a92a2d6c34fc11ebe27271e09fe9f254698f205681ef115016c
+SHA512:
+  metadata.gz: 256b728c8219f6ecfb31c903df100b13dd85553a657e247b27335f9b4273b0ea5af41d65a3ec99f5306311b979d0674f260907faf1f60f74b13f7e23abe55976
+  data.tar.gz: 3d3699152e36c56e27bf6f592ba960977c1c933ba7aa5b991188fc02ac523f7afc0689dd81ac03c1e853550a183d3253aa774a59ddbbd1cf107209d158083b30

data/README.md

@@ -0,0 +1,32 @@
+# Jekyll High-res Link
+
+A jekyll plugin that wraps <img> tags with links to uncompressed originals, saving bandwidth
+
+## Usage
+
+1. Add the pulgin to your Gemfile
+```
+gem 'jekyll-highres-link'
+```
+
+2. Add the plugin to your _config file:
+```
+plugins:
+  - jekyll-highres-link
+  - OTHER_PLUGINS...
+```
+
+3. Configure the path for the uncompressed images. You can either go with relative or absolute paths (from the root of the project). For absolute paths add in the _config.yaml file the directory with a starting "/":
+```
+highres-link:
+  - uncompressed_dir: /absolute/path
+```
+OR, if the uncompressed images depend on the image location, don't add a starting "/"
+```
+highres-link:
+  - uncompressed_dir: relative/path
+```
+4. That's it!
+
+## To be added
+- [ ] Automatically compress the images (for now, you can run the following fish script: [compress.fish](https://gist.github.com/Perseus333/8a161ffa160b0d2f6c2fd3c9756b1568))

data/lib/jekyll/highres-link.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module Jekyll
+  module HighresLink
+    class WrapImages
+      DEFAULT_UNCOMPRESSED_DIR = "uncompressed"
+
+      def self.process(doc)
+        return unless doc.output_ext == ".html"
+
+        config = doc.site.config["highres-link"] || {}
+        uncompressed_dir = config["uncompressed_dir"] || DEFAULT_UNCOMPRESSED_DIR
+
+        html = Nokogiri::HTML::DocumentFragment.parse(doc.output)
+        changed = false
+
+        html.css("img").each do |img|
+          src = img["src"]
+          
+          unless src
+            next
+          end
+          
+          rel_path = src.sub(%r{^/?}, "")
+          original_path = find_original_file(rel_path, uncompressed_dir)
+
+          unless original_path
+            Jekyll.logger.debug "HighresLink:", "\tNo original found for: #{rel_path}"
+            next
+          end
+
+          href = "/#{original_path}"
+          Jekyll.logger.info "HighresLink:", "\tWrapping with link to: #{href}"
+
+          link = Nokogiri::XML::Node.new("a", html)
+          link["href"] = href
+          link["target"] = "_blank"
+
+          img.replace(link)
+          link.add_child(img)
+          changed = true
+        end
+
+        doc.output = html.to_html if changed
+      end
+
+      def self.find_original_file(rel_path, uncompressed_dir)
+        basename = File.basename(rel_path, File.extname(rel_path))
+        dir = File.dirname(rel_path)
+
+        base_dir = if uncompressed_dir.start_with?("/")
+                     File.join(uncompressed_dir, basename)
+                   else
+                     File.join(dir, uncompressed_dir)
+                   end
+
+        %w[png jpg jpeg webp gif svg].each do |ext|
+          candidate = File.join(base_dir, "#{basename}.#{ext}")
+          
+          if File.exist?(candidate)
+            return candidate
+          end
+        end
+        
+        nil
+      end
+    end
+  end
+end

data/lib/jekyll-highres-link/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module HighresLink
+    VERSION = "0.0.1"
+  end
+end

data/lib/jekyll-highres-link.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "nokogiri"
+require_relative "jekyll/highres-link"
+
+Jekyll::Hooks.register [:pages, :documents], :post_render, priority: :low do |page|
+  Jekyll::HighresLink::WrapImages.process(page)
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-highres-link
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Perseus (Lynx)
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Jekyll plugin that automatically wraps <img> tags with links to their
+  high-res versions
+email:
+- perseuslynx333@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/jekyll-highres-link.rb
+- lib/jekyll-highres-link/version.rb
+- lib/jekyll/highres-link.rb
+homepage: https://github.com/perseus333/jekyll-highres-link
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '5.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Wraps images with links to high-resolution originals
+test_files: []