jekyll-hover-popup 0.1.0

data/lib/jekyll/hover_popup/asset_file.rb

@@ -0,0 +1,17 @@
+module Jekyll
+  module HoverPopup
+    class AssetFile < Jekyll::StaticFile
+      def initialize(site, base, dir, name, source_path:)
+        super(site, base, dir, name)
+        @source_path = source_path
+      end
+
+      def write(dest)
+        dest_path = destination(dest)
+        FileUtils.mkdir_p(File.dirname(dest_path))
+        FileUtils.cp(@source_path, dest_path)
+        true
+      end
+    end
+  end
+end

data/lib/jekyll/hover_popup/generator.rb

@@ -0,0 +1,34 @@
+module Jekyll
+  module HoverPopup
+    class Generator < Jekyll::Generator
+      safe true
+      priority :low
+
+      def generate(site)
+        cfg = (site.config["hover_popup"] || {})
+        return if cfg["enabled"] == false
+
+        assets_path = cfg["assets_path"] || "/assets/jekyll-hover-popup"
+        assets_path = "/#{assets_path}" unless assets_path.start_with?("/")
+
+        asset_dir = File.expand_path("../../../assets/jekyll-hover-popup", __dir__)
+
+        files = {
+          "hover_popup.js" => File.join(asset_dir, "hover_popup.js"),
+          "hover_popup.css" => File.join(asset_dir, "hover_popup.css"),
+        }
+
+        files.each do |name, source_path|
+          next unless File.file?(source_path)
+          site.static_files << AssetFile.new(
+            site,
+            site.source,
+            assets_path.sub(%r{\A/}, ""),
+            name,
+            source_path: source_path
+          )
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/hover_popup/hooks.rb

@@ -0,0 +1,48 @@
+module Jekyll
+  module HoverPopup
+    module Hooks
+      def self.register!
+        Jekyll::Hooks.register(%i[pages documents], :post_render) do |doc|
+          site = doc.site
+          cfg = (site.config["hover_popup"] || {})
+          next if cfg["enabled"] == false
+          next unless doc.respond_to?(:output_ext) && doc.output_ext == ".html"
+
+          assets_path = cfg["assets_path"] || "/assets/jekyll-hover-popup"
+          assets_path = "/#{assets_path}" unless assets_path.start_with?("/")
+          hover_delay_ms = cfg["hover_delay_ms"] || 0
+          nav_hover_preview = cfg.fetch("nav_hover_preview", true)
+
+          begin
+            doc.output = inject_assets(doc.output.to_s, assets_path: assets_path, hover_delay_ms: hover_delay_ms, nav_hover_preview: nav_hover_preview)
+          rescue StandardError => e
+            Jekyll.logger.warn("jekyll-hover-popup:", "Failed to process #{doc.relative_path}: #{e.class}: #{e.message}")
+          end
+        end
+      end
+
+      def self.inject_assets(html, assets_path:, hover_delay_ms:, nav_hover_preview: true)
+        return html if html.include?('data-hover-popup-root="true"')
+
+        tags = <<~HTML
+          <script>
+            window.__JHP_CONFIG__ = #{{
+              hoverDelayMs: hover_delay_ms,
+              navHoverPreview: nav_hover_preview
+            }.to_json};
+          </script>
+          <link rel="stylesheet" href="#{assets_path}/hover_popup.css" />
+          <script defer src="#{assets_path}/hover_popup.js" data-hover-popup-root="true"></script>
+        HTML
+
+        if html.include?("</body>")
+          html.sub("</body>", "#{tags}\n</body>")
+        else
+          "#{html}\n#{tags}\n"
+        end
+      end
+    end
+  end
+end
+
+Jekyll::HoverPopup::Hooks.register!

data/lib/jekyll/hover_popup/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module HoverPopup
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll-hover-popup.rb

@@ -0,0 +1,6 @@
+require "jekyll"
+
+require_relative "jekyll/hover_popup/version"
+require_relative "jekyll/hover_popup/asset_file"
+require_relative "jekyll/hover_popup/generator"
+require_relative "jekyll/hover_popup/hooks"

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-hover-popup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- directsun
+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: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- assets/jekyll-hover-popup/hover_popup.css
+- assets/jekyll-hover-popup/hover_popup.js
+- lib/jekyll-hover-popup.rb
+- lib/jekyll/hover_popup/asset_file.rb
+- lib/jekyll/hover_popup/generator.rb
+- lib/jekyll/hover_popup/hooks.rb
+- lib/jekyll/hover_popup/version.rb
+homepage: https://github.com/sunflowermans/hover-popup
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Jekyll plugin that shows in-page hover previews for internal documentation
+  links.
+test_files: []